The Orders API allows you to create orders, track order lifecycles and get current order status (including shipment information) for those orders.
Create an order to be fulfilled.
Shipment and Delivery SLAs All orders are assigned a shipping date based on when they were originally placed. All orders are assigned a shipping SLA for expected shipment time and delivery time after being imported. To meet buyer expectations it's vital that this reflects customer expectations when the order is placed.
The logic of evaluating the provided field is:
Ok
required | object (Address) | ||||||||||||||||||||||
| |||||||||||||||||||||||
cost | number or null <double> (Maybe_Scalars-at-Float_) A fulfillment order's cost | ||||||||||||||||||||||
id required | string A globally-unique identifier. | ||||||||||||||||||||||
createdAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was created. | ||||||||||||||||||||||
updatedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was last modified. | ||||||||||||||||||||||
object or null (Maybe_OrderError_) | |||||||||||||||||||||||
| |||||||||||||||||||||||
deliveredAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the entire fulfillment order (all packages) were reported as completing delivery to the buyer. | ||||||||||||||||||||||
externalOrderId | string or null (Maybe_Scalars-at-String_) A unique order reference meaningful to the external system submitting the order. | ||||||||||||||||||||||
required | Array of objects (OrderLineItem) A list of the fulfillment order's line items. | ||||||||||||||||||||||
promisedDeliveryByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and after promisedShipByTime. | ||||||||||||||||||||||
promisedShipByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should ship by, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and before promisedDeliveryByTime. | ||||||||||||||||||||||
shippedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the fulfillment order was reported as shipped to the buyer. | ||||||||||||||||||||||
source | string or null (Maybe_SourceId_) The name of the system originating the order such as SHOPIFY, AMAZON, WEBSITE, WALMART or similar. This is a vital field if the source marketplace restricts which carriers are allowed to be used. | ||||||||||||||||||||||
required | object (OrderState) | ||||||||||||||||||||||
required | Array of objects (FulfillmentShipmentModel) | ||||||||||||||||||||||
Array
|
Unauthorized
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "externalOrderId": "string",
- "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "deliveryDays": 0,
- "duties": {
- "incoterm": "DAP",
- "merchantOfRecordAccountId": "string",
- "merchantOfRecordCarrierCode": "string",
- "merchantOfRecordOrderId": "string",
- "merchantOfRecordProvider": "GLOBALE",
- "merchantOfRecordSkuMap": [
- {
- "dsku": "string",
- "msku": "string",
- "quantity": 0
}
]
}, - "isSubscriptionOrder": true,
- "shipMethod": "string",
- "lineItems": [
- {
- "quantity": 1,
- "logisticsSku": "string",
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}
}
], - "packingSlipUrl": "string"
}
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "cost": 0,
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "error": {
- "code": 0,
- "lineItemErrors": [
- {
- "logisticsSku": "string"
}
], - "message": "string",
- "retriable": true,
- "type": "PARTIALLY_SHIPPED"
}, - "deliveredAt": "2019-08-24T14:15:22Z",
- "externalOrderId": "string",
- "lineItems": [
- {
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}, - "logisticsSku": "string",
- "quantity": 0
}
], - "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "shippedAt": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "state": {
- "fulfillmentDelayed": true,
- "fulfillmentInProgress": true,
- "fulfillmentStatus": "DELIVERED",
- "internalStatus": "CANCELLED"
}, - "shipments": [
- {
- "packages": [
- {
- "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierPickUpTime": "2019-08-24T14:15:22Z",
- "carrierShipTime": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "label": {
- "carrier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "labelFormat": "PDF",
- "labelUrl": "string",
- "packageDimensions": {
- "height": 0,
- "length": 0,
- "lengthUnit": "in",
- "weight": 0,
- "weightUnit": "oz",
- "width": 0
}, - "shippingMethod": "string",
- "trackingCode": "string",
- "trackingUrl": "string"
}, - "labelCreateTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "expirationDate": "2019-08-24T14:15:22Z",
- "logisticsSku": "string",
- "lotNumber": "string",
- "quantity": 0
}
]
}
], - "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "status": "CANCELLED",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "estimatedShipTime": "2019-08-24T14:15:22Z",
- "labelPrintTime": "2019-08-24T14:15:22Z",
- "warehouseId": "string",
- "warehouseOrderId": "string"
}
]
}
Returns a FulfillmentOrder resource by ID.
Ok
required | object (Address) | ||||||||||||||||||||||
| |||||||||||||||||||||||
cost | number or null <double> (Maybe_Scalars-at-Float_) A fulfillment order's cost | ||||||||||||||||||||||
id required | string A globally-unique identifier. | ||||||||||||||||||||||
createdAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was created. | ||||||||||||||||||||||
updatedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was last modified. | ||||||||||||||||||||||
object or null (Maybe_OrderError_) | |||||||||||||||||||||||
| |||||||||||||||||||||||
deliveredAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the entire fulfillment order (all packages) were reported as completing delivery to the buyer. | ||||||||||||||||||||||
externalOrderId | string or null (Maybe_Scalars-at-String_) A unique order reference meaningful to the external system submitting the order. | ||||||||||||||||||||||
required | Array of objects (OrderLineItem) A list of the fulfillment order's line items. | ||||||||||||||||||||||
promisedDeliveryByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and after promisedShipByTime. | ||||||||||||||||||||||
promisedShipByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should ship by, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and before promisedDeliveryByTime. | ||||||||||||||||||||||
shippedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the fulfillment order was reported as shipped to the buyer. | ||||||||||||||||||||||
source | string or null (Maybe_SourceId_) The name of the system originating the order such as SHOPIFY, AMAZON, WEBSITE, WALMART or similar. This is a vital field if the source marketplace restricts which carriers are allowed to be used. | ||||||||||||||||||||||
required | object (OrderState) | ||||||||||||||||||||||
required | Array of objects (FulfillmentShipmentModel) | ||||||||||||||||||||||
Array
|
Unauthorized
Order not found
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "cost": 0,
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "error": {
- "code": 0,
- "lineItemErrors": [
- {
- "logisticsSku": "string"
}
], - "message": "string",
- "retriable": true,
- "type": "PARTIALLY_SHIPPED"
}, - "deliveredAt": "2019-08-24T14:15:22Z",
- "externalOrderId": "string",
- "lineItems": [
- {
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}, - "logisticsSku": "string",
- "quantity": 0
}
], - "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "shippedAt": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "state": {
- "fulfillmentDelayed": true,
- "fulfillmentInProgress": true,
- "fulfillmentStatus": "DELIVERED",
- "internalStatus": "CANCELLED"
}, - "shipments": [
- {
- "packages": [
- {
- "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierPickUpTime": "2019-08-24T14:15:22Z",
- "carrierShipTime": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "label": {
- "carrier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "labelFormat": "PDF",
- "labelUrl": "string",
- "packageDimensions": {
- "height": 0,
- "length": 0,
- "lengthUnit": "in",
- "weight": 0,
- "weightUnit": "oz",
- "width": 0
}, - "shippingMethod": "string",
- "trackingCode": "string",
- "trackingUrl": "string"
}, - "labelCreateTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "expirationDate": "2019-08-24T14:15:22Z",
- "logisticsSku": "string",
- "lotNumber": "string",
- "quantity": 0
}
]
}
], - "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "status": "CANCELLED",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "estimatedShipTime": "2019-08-24T14:15:22Z",
- "labelPrintTime": "2019-08-24T14:15:22Z",
- "warehouseId": "string",
- "warehouseOrderId": "string"
}
]
}
Get order information for an order created via the "Create order" endpoint, using the external order ID given during order creation.
Ok
required | object (Address) | ||||||||||||||||||||||
| |||||||||||||||||||||||
cost | number or null <double> (Maybe_Scalars-at-Float_) A fulfillment order's cost | ||||||||||||||||||||||
id required | string A globally-unique identifier. | ||||||||||||||||||||||
createdAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was created. | ||||||||||||||||||||||
updatedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was last modified. | ||||||||||||||||||||||
object or null (Maybe_OrderError_) | |||||||||||||||||||||||
| |||||||||||||||||||||||
deliveredAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the entire fulfillment order (all packages) were reported as completing delivery to the buyer. | ||||||||||||||||||||||
externalOrderId | string or null (Maybe_Scalars-at-String_) A unique order reference meaningful to the external system submitting the order. | ||||||||||||||||||||||
required | Array of objects (OrderLineItem) A list of the fulfillment order's line items. | ||||||||||||||||||||||
promisedDeliveryByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and after promisedShipByTime. | ||||||||||||||||||||||
promisedShipByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should ship by, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and before promisedDeliveryByTime. | ||||||||||||||||||||||
shippedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the fulfillment order was reported as shipped to the buyer. | ||||||||||||||||||||||
source | string or null (Maybe_SourceId_) The name of the system originating the order such as SHOPIFY, AMAZON, WEBSITE, WALMART or similar. This is a vital field if the source marketplace restricts which carriers are allowed to be used. | ||||||||||||||||||||||
required | object (OrderState) | ||||||||||||||||||||||
required | Array of objects (FulfillmentShipmentModel) | ||||||||||||||||||||||
Array
|
Unauthorized
Order not found
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "cost": 0,
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "error": {
- "code": 0,
- "lineItemErrors": [
- {
- "logisticsSku": "string"
}
], - "message": "string",
- "retriable": true,
- "type": "PARTIALLY_SHIPPED"
}, - "deliveredAt": "2019-08-24T14:15:22Z",
- "externalOrderId": "string",
- "lineItems": [
- {
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}, - "logisticsSku": "string",
- "quantity": 0
}
], - "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "shippedAt": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "state": {
- "fulfillmentDelayed": true,
- "fulfillmentInProgress": true,
- "fulfillmentStatus": "DELIVERED",
- "internalStatus": "CANCELLED"
}, - "shipments": [
- {
- "packages": [
- {
- "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierPickUpTime": "2019-08-24T14:15:22Z",
- "carrierShipTime": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "label": {
- "carrier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "labelFormat": "PDF",
- "labelUrl": "string",
- "packageDimensions": {
- "height": 0,
- "length": 0,
- "lengthUnit": "in",
- "weight": 0,
- "weightUnit": "oz",
- "width": 0
}, - "shippingMethod": "string",
- "trackingCode": "string",
- "trackingUrl": "string"
}, - "labelCreateTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "expirationDate": "2019-08-24T14:15:22Z",
- "logisticsSku": "string",
- "lotNumber": "string",
- "quantity": 0
}
]
}
], - "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "status": "CANCELLED",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "estimatedShipTime": "2019-08-24T14:15:22Z",
- "labelPrintTime": "2019-08-24T14:15:22Z",
- "warehouseId": "string",
- "warehouseOrderId": "string"
}
]
}
Retries processing of a fulfillment order.
Ok
required | object (Address) | ||||||||||||||||||||||
| |||||||||||||||||||||||
cost | number or null <double> (Maybe_Scalars-at-Float_) A fulfillment order's cost | ||||||||||||||||||||||
id required | string A globally-unique identifier. | ||||||||||||||||||||||
createdAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was created. | ||||||||||||||||||||||
updatedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was last modified. | ||||||||||||||||||||||
object or null (Maybe_OrderError_) | |||||||||||||||||||||||
| |||||||||||||||||||||||
deliveredAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the entire fulfillment order (all packages) were reported as completing delivery to the buyer. | ||||||||||||||||||||||
externalOrderId | string or null (Maybe_Scalars-at-String_) A unique order reference meaningful to the external system submitting the order. | ||||||||||||||||||||||
required | Array of objects (OrderLineItem) A list of the fulfillment order's line items. | ||||||||||||||||||||||
promisedDeliveryByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and after promisedShipByTime. | ||||||||||||||||||||||
promisedShipByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should ship by, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and before promisedDeliveryByTime. | ||||||||||||||||||||||
shippedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the fulfillment order was reported as shipped to the buyer. | ||||||||||||||||||||||
source | string or null (Maybe_SourceId_) The name of the system originating the order such as SHOPIFY, AMAZON, WEBSITE, WALMART or similar. This is a vital field if the source marketplace restricts which carriers are allowed to be used. | ||||||||||||||||||||||
required | object (OrderState) | ||||||||||||||||||||||
required | Array of objects (FulfillmentShipmentModel) | ||||||||||||||||||||||
Array
|
Unauthorized
Order not found
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "cost": 0,
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "error": {
- "code": 0,
- "lineItemErrors": [
- {
- "logisticsSku": "string"
}
], - "message": "string",
- "retriable": true,
- "type": "PARTIALLY_SHIPPED"
}, - "deliveredAt": "2019-08-24T14:15:22Z",
- "externalOrderId": "string",
- "lineItems": [
- {
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}, - "logisticsSku": "string",
- "quantity": 0
}
], - "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "shippedAt": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "state": {
- "fulfillmentDelayed": true,
- "fulfillmentInProgress": true,
- "fulfillmentStatus": "DELIVERED",
- "internalStatus": "CANCELLED"
}, - "shipments": [
- {
- "packages": [
- {
- "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierPickUpTime": "2019-08-24T14:15:22Z",
- "carrierShipTime": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "label": {
- "carrier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "labelFormat": "PDF",
- "labelUrl": "string",
- "packageDimensions": {
- "height": 0,
- "length": 0,
- "lengthUnit": "in",
- "weight": 0,
- "weightUnit": "oz",
- "width": 0
}, - "shippingMethod": "string",
- "trackingCode": "string",
- "trackingUrl": "string"
}, - "labelCreateTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "expirationDate": "2019-08-24T14:15:22Z",
- "logisticsSku": "string",
- "lotNumber": "string",
- "quantity": 0
}
]
}
], - "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "status": "CANCELLED",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "estimatedShipTime": "2019-08-24T14:15:22Z",
- "labelPrintTime": "2019-08-24T14:15:22Z",
- "warehouseId": "string",
- "warehouseOrderId": "string"
}
]
}
Cancel an order that was created via the "Create Order" endpoint. If an order has already been processed and shipped, the order cannot be cancelled.
Ok
required | object (Address) | ||||||||||||||||||||||
| |||||||||||||||||||||||
cost | number or null <double> (Maybe_Scalars-at-Float_) A fulfillment order's cost | ||||||||||||||||||||||
id required | string A globally-unique identifier. | ||||||||||||||||||||||
createdAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was created. | ||||||||||||||||||||||
updatedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) when the fulfillment was last modified. | ||||||||||||||||||||||
object or null (Maybe_OrderError_) | |||||||||||||||||||||||
| |||||||||||||||||||||||
deliveredAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the entire fulfillment order (all packages) were reported as completing delivery to the buyer. | ||||||||||||||||||||||
externalOrderId | string or null (Maybe_Scalars-at-String_) A unique order reference meaningful to the external system submitting the order. | ||||||||||||||||||||||
required | Array of objects (OrderLineItem) A list of the fulfillment order's line items. | ||||||||||||||||||||||
promisedDeliveryByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and after promisedShipByTime. | ||||||||||||||||||||||
promisedShipByTime | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) the packages in this fulfillment order should ship by, based on expectations given to customers or set by the originating marketplace. This date and time needs to be in the future and before promisedDeliveryByTime. | ||||||||||||||||||||||
shippedAt | string or null <date-time> (Maybe_Scalars-at-Date_) The date and time (ISO 8601 format) that the fulfillment order was reported as shipped to the buyer. | ||||||||||||||||||||||
source | string or null (Maybe_SourceId_) The name of the system originating the order such as SHOPIFY, AMAZON, WEBSITE, WALMART or similar. This is a vital field if the source marketplace restricts which carriers are allowed to be used. | ||||||||||||||||||||||
required | object (OrderState) | ||||||||||||||||||||||
required | Array of objects (FulfillmentShipmentModel) | ||||||||||||||||||||||
Array
|
Unauthorized
Order not found
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "string",
- "name": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "cost": 0,
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "error": {
- "code": 0,
- "lineItemErrors": [
- {
- "logisticsSku": "string"
}
], - "message": "string",
- "retriable": true,
- "type": "PARTIALLY_SHIPPED"
}, - "deliveredAt": "2019-08-24T14:15:22Z",
- "externalOrderId": "string",
- "lineItems": [
- {
- "customsUnitValue": {
- "amount": 0,
- "currencyCode": "string"
}, - "logisticsSku": "string",
- "quantity": 0
}
], - "promisedDeliveryByTime": "2019-08-24T14:15:22Z",
- "promisedShipByTime": "2019-08-24T14:15:22Z",
- "shippedAt": "2019-08-24T14:15:22Z",
- "source": "AMAZON",
- "state": {
- "fulfillmentDelayed": true,
- "fulfillmentInProgress": true,
- "fulfillmentStatus": "DELIVERED",
- "internalStatus": "CANCELLED"
}, - "shipments": [
- {
- "packages": [
- {
- "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierDeliveryTime": "2019-08-24T14:15:22Z",
- "carrierPickUpTime": "2019-08-24T14:15:22Z",
- "carrierShipTime": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "label": {
- "carrier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "labelFormat": "PDF",
- "labelUrl": "string",
- "packageDimensions": {
- "height": 0,
- "length": 0,
- "lengthUnit": "in",
- "weight": 0,
- "weightUnit": "oz",
- "width": 0
}, - "shippingMethod": "string",
- "trackingCode": "string",
- "trackingUrl": "string"
}, - "labelCreateTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "expirationDate": "2019-08-24T14:15:22Z",
- "logisticsSku": "string",
- "lotNumber": "string",
- "quantity": 0
}
]
}
], - "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "status": "CANCELLED",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "estimatedShipTime": "2019-08-24T14:15:22Z",
- "labelPrintTime": "2019-08-24T14:15:22Z",
- "warehouseId": "string",
- "warehouseOrderId": "string"
}
]
}