object Warehouse

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idString

Public API account ID that identifies the related record.

identifierString

Name of the warehouse.

dynamic_slottingBoolean

Whether dynamic slotting is enabled for this warehouse.

invoice_emailString

Email address for the invoice contact.

phone_numberString

Phone number for the phone number contact.

profileString

Profile for this warehouse.

addressAddress

Address details for this warehouse.

return_addressAddress

Return address for this warehouse.

company_nameString

Company name for this warehouse.

company_aliasString

Company alias for this warehouse.

activeBoolean

Whether this warehouse is active.

productsProductConnection

List of products associated with this warehouse.

ArgumentTypeRequiredDefaultDescription
sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "V2FyZWhvdXNlOjEyMzQ=",
  "identifier": "Primary Warehouse",
  "dynamic_slotting": true,
  "invoice_email": "customer@example.com",
  "phone_number": "+1-555-0100",
  "profile": "default",
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "return_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "company_name": "Acme Corp",
  "company_alias": "Acme Corp",
  "active": true,
  "products": [{sku: "BLUE-TEE-M", name: "Blue Tee"}]
}