object WarehouseProfile
Fields
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String | Public API ID for this identifiable. | ||||||||||||||||||||||||||||||
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. | ||||||||||||||||||||||||||||||
account_id | String | Public API account ID that identifies the related record. | ||||||||||||||||||||||||||||||
identifier | String | Name of the warehouse. | ||||||||||||||||||||||||||||||
dynamic_slotting | Boolean | Whether dynamic slotting is enabled for this warehouse. | ||||||||||||||||||||||||||||||
invoice_email | String | Email address for the invoice contact. | ||||||||||||||||||||||||||||||
invoice_note | String | Note displayed on invoices. | ||||||||||||||||||||||||||||||
invoice_logo_url | String | Shareable URL of the invoice logo stored by ShipHero. | ||||||||||||||||||||||||||||||
phone_number | String | Phone number for the phone number contact. | ||||||||||||||||||||||||||||||
profile | String | Profile for this warehouse. | ||||||||||||||||||||||||||||||
language | String | Invoice language code. | ||||||||||||||||||||||||||||||
manual_order_prefix | String | Prefix used for manually created orders. | ||||||||||||||||||||||||||||||
show_phone_on_invoice | Boolean | Whether the phone number is displayed on invoices. | ||||||||||||||||||||||||||||||
only_pick_orders_with_required_ship_date_today_or_earlier | Boolean | Whether picking is limited to orders required to ship today or earlier. | ||||||||||||||||||||||||||||||
exclude_stock_from_available_to_sell | Boolean | Whether this warehouse profile's stock is excluded from available-to-sell calculations. | ||||||||||||||||||||||||||||||
address | Address | Address details for this warehouse. | ||||||||||||||||||||||||||||||
return_address | Address | Return address for this warehouse. | ||||||||||||||||||||||||||||||
invoice_address | Address | Sender/company address displayed on invoices. | ||||||||||||||||||||||||||||||
label_address | Address | Return address displayed on shipping labels. | ||||||||||||||||||||||||||||||
company_name | String | Company name for this warehouse. | ||||||||||||||||||||||||||||||
company_alias | String | Company alias for this warehouse. | ||||||||||||||||||||||||||||||
active | Boolean | Whether this warehouse is active. | ||||||||||||||||||||||||||||||
products | ProductConnection | List of products associated with this warehouse. | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
warehouse_id | String | Public API ID of the source physical warehouse associated with this profile. | ||||||||||||||||||||||||||||||
Referenced By
Example
{
"id": "UmVjb3JkOjEyMzQ=",
"legacy_id": 1234,
"account_id": "V2FyZWhvdXNlOjEyMzQ=",
"identifier": "Primary Warehouse",
"dynamic_slotting": true,
"invoice_email": "customer@example.com",
"invoice_note": "Thank you for your order.",
"invoice_logo_url": "abc123",
"phone_number": "+1-555-0100",
"profile": "default",
"language": "en",
"manual_order_prefix": "MO",
"show_phone_on_invoice": true,
"only_pick_orders_with_required_ship_date_today_or_earlier": true,
"exclude_stock_from_available_to_sell": true,
"address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
"return_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
"invoice_address": Address,
"label_address": Address,
"company_name": "Acme Corp",
"company_alias": "Acme Corp",
"active": true,
"products": [{sku: "BLUE-TEE-M", name: "Blue Tee"}],
"warehouse_id": "abc123"
}