Column | Description |
---|---|
locationNum (Required) | Specifies the unique location number. |
name (Required) | Specifies the location name. |
isActive | Determines if the location is active or inactive for order fulfillment operations. This can be set to TRUE for active and FALSE for inactive. |
address_addressLine1 | Specifies the locations first address line. |
address_addressLine2 | Specifies the locations second address line. |
address_addressLine3 | Specifies the locations third address line. |
address_addressLine4 | Specifies the locations fourth address line. |
address_city | Specifies the location city name. |
address_countryCode | Specifies the locations country code. For example, CA for Canada or US for United States. |
address_state (Required) | Specifies the locations region, state, or province. |
address_postalCode | Specifies the locations postal or zip code. |
address_type | Specifies the locations address type. For example, Home or Business . |
contacts | Specifies the locations contact details. Each child attribute in the contacts object is separated by an underscore. For example, HOME_home@gmail.com_604-999-1860_JoeMadison . |
capacity_isInfiniteAllocation | Determines if the location has a capacity limit or not. Set to TRUE to disable capacity limit and FALSE to enable capacity limit. |
capacity_maxAllocations | Determines the locations capacity limit amount. For example, 100 allocations. This value is required if capacity_isInfiniteAllocation is FALSE . |
capacity_currentAllocations | Specifies the locations current amount of allocations. This value is required if capacity_isInfiniteAllocation is FALSE . |
operatingHours_day_hours_open_hours_close_hours_type | Specifies the locations operating hours. The following format is used to provide operation hours, day of the week, store opening time in 24 hour format, closing time in 24 hour format, location type. For example, MONDAY_2022-10-19T15:26:30.884+00:00_2022-10-19T15:26:30.884+00:00_PICKUP . |
attributes_source | Example of a custom source attribute. By default this columns values are empty. |
attributes_openedAt | Example of a custom date-time attribute. By default this columns values are empty. |
attributes_region | Example of a custom region attribute. By default this columns values are empty. |
services_channel | Specifies the locations sales channel ID. |
services_brand | Specifies the locations brands. |
Column | Description |
---|---|
disabledFulfillmentMethods (Required) | Specifies the fulfillment method you want to disable for a location. For example, ["PICKUP"] . |
locationNumber (Required) | Specifies the unique location number. |
schedule.endDate | Specifies the end date and time of the location outage in UTC format. For example, 2025-12-20T09:30:31.198Z . |
schedule.isIndefinite (Required) | Determines whether the location outage remains in effect indefinitely. Set to FALSE if you have provided a start and end data for the outage. Set to TRUE if you want the outage to remain in effect indefinitely. |
schedule.startDate | Specifies the start date and time of the location outage in UTC format. For example, 2025-12-20T09:30:31.198Z . |
outageNumber | Indicates the reason for the outage. |
Column | Description |
---|---|
capacity (Required) | Specifies the temporary capacity increase amount. For example, 100 . |
locationNumber (Required) | Specifies the unique location number. |
schedule.startDate | Specifies the start date and time of the capacity override in UTC format. For example, 2025-12-20T09:30:31.198Z . |
schedule.endDate | Specifies the end date and time of the capacity override in UTC format. For example, 2025-12-20T09:30:31.198Z . |
schedule.isIndefinite (Required) | Determines whether the capacity override remains in effect indefinitely. Set to FALSE if you have provided a start and end data for the override. Set to TRUE if you want the override to remain in effect indefinitely. |