object Account

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.

email

String

Email address for the contact.

username

String

Username for this account.

status

String

Current status; use the API status values returned by this field when filtering or updating.

dynamic_slotting

Boolean

Whether dynamic slotting is enabled for this account.

is_multi_warehouse

Boolean

Whether this account is multi warehouse.

is_3pl

Boolean

Whether this account is 3PL.

cycle_count_enabled

Boolean

Whether cycle counting is enabled for this account.

ship_backorders

Boolean

Whether this account allows backordered items to ship.

warehouse_relationship

WarehouseRelationship

Warehouse relationship for this account.

lot_tracking_settings

AccountLotTrackingSettings

Lot tracking settings for this account.

customers

AccountConnection

Customers for this account.

Argument	Type	Required	Description
`warehouse_id`	`String`	No	Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

warehouses

[Warehouse]

List of warehouses for this account.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "email": "customer@example.com",
  "username": "2",
  "status": "pending",
  "dynamic_slotting": true,
  "is_multi_warehouse": true,
  "is_3pl": true,
  "cycle_count_enabled": true,
  "ship_backorders": true,
  "warehouse_relationship": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "lot_tracking_settings": {id: "QWNjb3VudExvdFRyYWNraW5nU2V0dGluZ3M6MTIzNA=="},
  "customers": [{id: "QWNjb3VudDoxMjM0"}],
  "warehouses": [[{id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"}]]
}