Orders

The Orders API allows you to create orders, track order lifecycles and get current order status (including shipment information) for those orders.

CreateOrder

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:

  1. If the promisedDeliveryByTime field is present and valid, the value will be set as the SLA time
  2. Otherwise, if the deliveryDays value is set and valid, that number of days will be added onto the calculated shipment date to determine the delivery date.
  3. Otherwise if the shipMethod is present, it will be mapped to a calculated delivery speed, if unrecognized or invalid, the shipping delivery date will be set to 5 days after the shipment date

SecurityBEARER
Request
Request Body schema: application/json
required
required
object (AddressInput)
address1
required
string

First address line of the address.

address2
string or null (InputMaybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (InputMaybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'

name
string or null (InputMaybe_Scalars-at-String_)

Name of entity.

phone
string or null (InputMaybe_Scalars-at-String_)

Phone number of the entity.

provinceCode
string or null (InputMaybe_Scalars-at-String_)

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
string or null (InputMaybe_Scalars-at-String_)

Postal code of the address.

externalOrderId
required
string

A unique order reference meaningful to the external system submitting the order.

promisedDeliveryByTime
string or null <date-time> (InputMaybe_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> (InputMaybe_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.

source
string or null (InputMaybe_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. If left blank, this will default to SHOPIFY

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
deliveryDays
number or null <double> (InputMaybe_Scalars-at-Int_)

Define the number of days in which this order must be delivered, counting from the date of shipment

object or null (InputMaybe_DutiesInput_)

Duties information for an order

incoterm
string or null (InputMaybe_Incoterm_)

Incoterm value for an order Ex: 'DDP', 'DAP'.

Enum: "DAP" "DDP" "DDU"
merchantOfRecordAccountId
required
string

The merchant GUID associated with Global-E.

merchantOfRecordCarrierCode
string or null (InputMaybe_Scalars-at-String_)

The carrier code used by the carrier.

merchantOfRecordOrderId
required
string

The merchant order ID associated with Global-E.

merchantOfRecordProvider
required
string (MerchantOfRecordProvider)

The merchant of record provider for the order.

Enum: "GLOBALE" "MARKETS_PRO"
Array of objects or null or null (InputMaybe_Array_InputMaybe_MerchantOfRecordSkuMapInput___)

A list of DSKU to MSKU mappings.

isSubscriptionOrder
boolean or null (InputMaybe_Scalars-at-Boolean_)

Is this order part of a recurring subscription for the customer

shipMethod
string or null (InputMaybe_Scalars-at-String_)

Text of ship method like 'Standard', 'UPS GROUND', etc.

required
Array of objects (OrderLineItemInput202401)

A list of the fulfillment order's line items.

Array
quantity
required
integer <int32> >= 1

The quantity of the product to ship for this order.

logisticsSku
required
string

Unique line item identifier. This can also be a bundle identifier.

object or null
packingSlipUrl
string

A URL referencing packing slip for this order. If passed, will override the default packing slip.

Responses
200

Ok

Response Schema: application/json
Any of:
required
object (Address)
address1
required
string

First address line of the address.

address2
string or null (Maybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (Maybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'.

name
string or null (Maybe_Scalars-at-String_)

Name of entity.

phone
required
string

Phone number of the entity.

provinceCode
required
string

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
required
string

Postal code of the 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_)
code
required
number <double>
Array of objects or null (Maybe_Array_LineItemError__)
message
required
string
retriable
required
boolean

Signals when an order error can be considered transient and can be retried manually by the caller. Attempting to create the order again will return a DUPLICATE_ORDER error, to retry please use the retry API.

type
required
string (OrderErrorType)
Enum: "PARTIALLY_SHIPPED" "BAD_ADDRESS" "BAD_PRODUCT_INFO" "CANNOT_SHIP_HAZMAT" "CARRIER_NETWORK_ERR" "DSKU_NEVER_INBOUNDED" "INTERNATIONAL_ADDRESS" "INVENTORY_ERR" "INVENTORY_TIMEOUT" "LABEL_PURCHASE_FAILURE" "MISSING_CUSTOMS_INFO" "MISSING_DDP_TAG" "MISSING_REMOVAL_FEE_SPECS" "MISSING_SHIPPING_SPECIFICATIONS_FOR_HAZMAT" "NON_PLT_ORDER_NOT_SUPPORTED" "NO_FEDEX_RATES" "NO_RATES" "NO_REMOVAL_PROPOSAL" "OVERSIZED_DIMS" "PARTIAL_FULFILL_FAILED" "PARTIAL_SHIP_UPDATE_FAILED" "PROMISE_TIME_EXPIRED" "REMOVALS_MINIMUM_NOT_MET" "REMOVAL_ON_HOLD" "STOCKOUT" "STOCKOUT_AT_INGESTION" "UNKNOWN" "UNKNOWN_SFP_STATUS" "UNREGISTERED_PRIME_PRODUCTS" "UNSUPPORTED_DESTINATION" "WAREHOUSE_ERR"
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.

Array
object or null (Maybe_Money_)
logisticsSku
required
string
quantity
required
number <double>
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.

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
required
object (OrderState)
fulfillmentDelayed
required
boolean
fulfillmentInProgress
required
boolean
fulfillmentStatus
required
string (ExternalOrderStatus)
Enum: "DELIVERED" "SHIPPED" "ROUTING_IN_PROGRESS" "STOPPED"
internalStatus
required
string (InternalOrderStatus)
Enum: "CANCELLED" "ERROR" "CREATED" "DELIVERED" "SHIPPED"
required
Array of objects (FulfillmentShipmentModel)
Array
required
Array of objects (FulfillmentPackage)
id
required
string

A globally-unique identifier.

createdAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the shipment object was created.

status
required
string (ShipmentStatus)

Status of shipment

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be delivered.

required
Array of objects (FulfillmentShipmentItem)
shippedAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the entire shipment (all packages) was shipped to the buyer.

estimatedShipTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be shipped.

labelPrintTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the label was printed.

warehouseId
required
string

The id of the location (warehouse) that the shipment was processed at.

warehouseOrderId
string or null (Maybe_Scalars-at-String_)

The id of the order at the location (warehouse) that the shipment was processed at.

401

Unauthorized

post/logistics/api/2024-04/orders
Request samples
application/json
{
  • "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": [
      • {
        }
      ]
    },
  • "isSubscriptionOrder": true,
  • "shipMethod": "string",
  • "lineItems": [
    • {
      • "quantity": 1,
      • "logisticsSku": "string",
      • "customsUnitValue": {
        }
      }
    ],
  • "packingSlipUrl": "string"
}
Response samples
application/json
{
  • "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": [
      • {
        }
      ],
    • "message": "string",
    • "retriable": true,
    • "type": "PARTIALLY_SHIPPED"
    },
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "externalOrderId": "string",
  • "lineItems": [
    • {
      • "customsUnitValue": {
        },
      • "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": [
        ],
      • "id": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "status": "CANCELLED",
      • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
      • "lineItems": [
        ],
      • "shippedAt": "2019-08-24T14:15:22Z",
      • "estimatedShipTime": "2019-08-24T14:15:22Z",
      • "labelPrintTime": "2019-08-24T14:15:22Z",
      • "warehouseId": "string",
      • "warehouseOrderId": "string"
      }
    ]
}

GetOrder

Returns a FulfillmentOrder resource by ID.

SecurityBEARER
Request
path Parameters
orderId
required
string (OrderIdType) ^\d+$

A unique identifier for this order.

Responses
200

Ok

Response Schema: application/json
Any of:
required
object (Address)
address1
required
string

First address line of the address.

address2
string or null (Maybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (Maybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'.

name
string or null (Maybe_Scalars-at-String_)

Name of entity.

phone
required
string

Phone number of the entity.

provinceCode
required
string

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
required
string

Postal code of the 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_)
code
required
number <double>
Array of objects or null (Maybe_Array_LineItemError__)
message
required
string
retriable
required
boolean

Signals when an order error can be considered transient and can be retried manually by the caller. Attempting to create the order again will return a DUPLICATE_ORDER error, to retry please use the retry API.

type
required
string (OrderErrorType)
Enum: "PARTIALLY_SHIPPED" "BAD_ADDRESS" "BAD_PRODUCT_INFO" "CANNOT_SHIP_HAZMAT" "CARRIER_NETWORK_ERR" "DSKU_NEVER_INBOUNDED" "INTERNATIONAL_ADDRESS" "INVENTORY_ERR" "INVENTORY_TIMEOUT" "LABEL_PURCHASE_FAILURE" "MISSING_CUSTOMS_INFO" "MISSING_DDP_TAG" "MISSING_REMOVAL_FEE_SPECS" "MISSING_SHIPPING_SPECIFICATIONS_FOR_HAZMAT" "NON_PLT_ORDER_NOT_SUPPORTED" "NO_FEDEX_RATES" "NO_RATES" "NO_REMOVAL_PROPOSAL" "OVERSIZED_DIMS" "PARTIAL_FULFILL_FAILED" "PARTIAL_SHIP_UPDATE_FAILED" "PROMISE_TIME_EXPIRED" "REMOVALS_MINIMUM_NOT_MET" "REMOVAL_ON_HOLD" "STOCKOUT" "STOCKOUT_AT_INGESTION" "UNKNOWN" "UNKNOWN_SFP_STATUS" "UNREGISTERED_PRIME_PRODUCTS" "UNSUPPORTED_DESTINATION" "WAREHOUSE_ERR"
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.

Array
object or null (Maybe_Money_)
logisticsSku
required
string
quantity
required
number <double>
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.

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
required
object (OrderState)
fulfillmentDelayed
required
boolean
fulfillmentInProgress
required
boolean
fulfillmentStatus
required
string (ExternalOrderStatus)
Enum: "DELIVERED" "SHIPPED" "ROUTING_IN_PROGRESS" "STOPPED"
internalStatus
required
string (InternalOrderStatus)
Enum: "CANCELLED" "ERROR" "CREATED" "DELIVERED" "SHIPPED"
required
Array of objects (FulfillmentShipmentModel)
Array
required
Array of objects (FulfillmentPackage)
id
required
string

A globally-unique identifier.

createdAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the shipment object was created.

status
required
string (ShipmentStatus)

Status of shipment

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be delivered.

required
Array of objects (FulfillmentShipmentItem)
shippedAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the entire shipment (all packages) was shipped to the buyer.

estimatedShipTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be shipped.

labelPrintTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the label was printed.

warehouseId
required
string

The id of the location (warehouse) that the shipment was processed at.

warehouseOrderId
string or null (Maybe_Scalars-at-String_)

The id of the order at the location (warehouse) that the shipment was processed at.

401

Unauthorized

404

Order not found

get/logistics/api/2024-04/orders/{orderId}
Response samples
application/json
{
  • "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": [
      • {
        }
      ],
    • "message": "string",
    • "retriable": true,
    • "type": "PARTIALLY_SHIPPED"
    },
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "externalOrderId": "string",
  • "lineItems": [
    • {
      • "customsUnitValue": {
        },
      • "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": [
        ],
      • "id": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "status": "CANCELLED",
      • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
      • "lineItems": [
        ],
      • "shippedAt": "2019-08-24T14:15:22Z",
      • "estimatedShipTime": "2019-08-24T14:15:22Z",
      • "labelPrintTime": "2019-08-24T14:15:22Z",
      • "warehouseId": "string",
      • "warehouseOrderId": "string"
      }
    ]
}

GetOrderByExternalId

Get order information for an order created via the "Create order" endpoint, using the external order ID given during order creation.

SecurityBEARER
Request
path Parameters
externalOrderId
required
string (ExternalOrderIdType)

A unique order reference meaningful to the external system submitting the order.

Responses
200

Ok

Response Schema: application/json
Any of:
required
object (Address)
address1
required
string

First address line of the address.

address2
string or null (Maybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (Maybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'.

name
string or null (Maybe_Scalars-at-String_)

Name of entity.

phone
required
string

Phone number of the entity.

provinceCode
required
string

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
required
string

Postal code of the 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_)
code
required
number <double>
Array of objects or null (Maybe_Array_LineItemError__)
message
required
string
retriable
required
boolean

Signals when an order error can be considered transient and can be retried manually by the caller. Attempting to create the order again will return a DUPLICATE_ORDER error, to retry please use the retry API.

type
required
string (OrderErrorType)
Enum: "PARTIALLY_SHIPPED" "BAD_ADDRESS" "BAD_PRODUCT_INFO" "CANNOT_SHIP_HAZMAT" "CARRIER_NETWORK_ERR" "DSKU_NEVER_INBOUNDED" "INTERNATIONAL_ADDRESS" "INVENTORY_ERR" "INVENTORY_TIMEOUT" "LABEL_PURCHASE_FAILURE" "MISSING_CUSTOMS_INFO" "MISSING_DDP_TAG" "MISSING_REMOVAL_FEE_SPECS" "MISSING_SHIPPING_SPECIFICATIONS_FOR_HAZMAT" "NON_PLT_ORDER_NOT_SUPPORTED" "NO_FEDEX_RATES" "NO_RATES" "NO_REMOVAL_PROPOSAL" "OVERSIZED_DIMS" "PARTIAL_FULFILL_FAILED" "PARTIAL_SHIP_UPDATE_FAILED" "PROMISE_TIME_EXPIRED" "REMOVALS_MINIMUM_NOT_MET" "REMOVAL_ON_HOLD" "STOCKOUT" "STOCKOUT_AT_INGESTION" "UNKNOWN" "UNKNOWN_SFP_STATUS" "UNREGISTERED_PRIME_PRODUCTS" "UNSUPPORTED_DESTINATION" "WAREHOUSE_ERR"
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.

Array
object or null (Maybe_Money_)
logisticsSku
required
string
quantity
required
number <double>
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.

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
required
object (OrderState)
fulfillmentDelayed
required
boolean
fulfillmentInProgress
required
boolean
fulfillmentStatus
required
string (ExternalOrderStatus)
Enum: "DELIVERED" "SHIPPED" "ROUTING_IN_PROGRESS" "STOPPED"
internalStatus
required
string (InternalOrderStatus)
Enum: "CANCELLED" "ERROR" "CREATED" "DELIVERED" "SHIPPED"
required
Array of objects (FulfillmentShipmentModel)
Array
required
Array of objects (FulfillmentPackage)
id
required
string

A globally-unique identifier.

createdAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the shipment object was created.

status
required
string (ShipmentStatus)

Status of shipment

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be delivered.

required
Array of objects (FulfillmentShipmentItem)
shippedAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the entire shipment (all packages) was shipped to the buyer.

estimatedShipTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be shipped.

labelPrintTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the label was printed.

warehouseId
required
string

The id of the location (warehouse) that the shipment was processed at.

warehouseOrderId
string or null (Maybe_Scalars-at-String_)

The id of the order at the location (warehouse) that the shipment was processed at.

401

Unauthorized

404

Order not found

get/logistics/api/2024-04/orders/external_id/{externalOrderId}
Response samples
application/json
{
  • "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": [
      • {
        }
      ],
    • "message": "string",
    • "retriable": true,
    • "type": "PARTIALLY_SHIPPED"
    },
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "externalOrderId": "string",
  • "lineItems": [
    • {
      • "customsUnitValue": {
        },
      • "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": [
        ],
      • "id": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "status": "CANCELLED",
      • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
      • "lineItems": [
        ],
      • "shippedAt": "2019-08-24T14:15:22Z",
      • "estimatedShipTime": "2019-08-24T14:15:22Z",
      • "labelPrintTime": "2019-08-24T14:15:22Z",
      • "warehouseId": "string",
      • "warehouseOrderId": "string"
      }
    ]
}

RetryOrder

Retries processing of a fulfillment order.

SecurityBEARER
Request
path Parameters
orderId
required
string (OrderIdType) ^\d+$

A unique identifier for this order.

Responses
200

Ok

Response Schema: application/json
Any of:
required
object (Address)
address1
required
string

First address line of the address.

address2
string or null (Maybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (Maybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'.

name
string or null (Maybe_Scalars-at-String_)

Name of entity.

phone
required
string

Phone number of the entity.

provinceCode
required
string

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
required
string

Postal code of the 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_)
code
required
number <double>
Array of objects or null (Maybe_Array_LineItemError__)
message
required
string
retriable
required
boolean

Signals when an order error can be considered transient and can be retried manually by the caller. Attempting to create the order again will return a DUPLICATE_ORDER error, to retry please use the retry API.

type
required
string (OrderErrorType)
Enum: "PARTIALLY_SHIPPED" "BAD_ADDRESS" "BAD_PRODUCT_INFO" "CANNOT_SHIP_HAZMAT" "CARRIER_NETWORK_ERR" "DSKU_NEVER_INBOUNDED" "INTERNATIONAL_ADDRESS" "INVENTORY_ERR" "INVENTORY_TIMEOUT" "LABEL_PURCHASE_FAILURE" "MISSING_CUSTOMS_INFO" "MISSING_DDP_TAG" "MISSING_REMOVAL_FEE_SPECS" "MISSING_SHIPPING_SPECIFICATIONS_FOR_HAZMAT" "NON_PLT_ORDER_NOT_SUPPORTED" "NO_FEDEX_RATES" "NO_RATES" "NO_REMOVAL_PROPOSAL" "OVERSIZED_DIMS" "PARTIAL_FULFILL_FAILED" "PARTIAL_SHIP_UPDATE_FAILED" "PROMISE_TIME_EXPIRED" "REMOVALS_MINIMUM_NOT_MET" "REMOVAL_ON_HOLD" "STOCKOUT" "STOCKOUT_AT_INGESTION" "UNKNOWN" "UNKNOWN_SFP_STATUS" "UNREGISTERED_PRIME_PRODUCTS" "UNSUPPORTED_DESTINATION" "WAREHOUSE_ERR"
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.

Array
object or null (Maybe_Money_)
logisticsSku
required
string
quantity
required
number <double>
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.

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
required
object (OrderState)
fulfillmentDelayed
required
boolean
fulfillmentInProgress
required
boolean
fulfillmentStatus
required
string (ExternalOrderStatus)
Enum: "DELIVERED" "SHIPPED" "ROUTING_IN_PROGRESS" "STOPPED"
internalStatus
required
string (InternalOrderStatus)
Enum: "CANCELLED" "ERROR" "CREATED" "DELIVERED" "SHIPPED"
required
Array of objects (FulfillmentShipmentModel)
Array
required
Array of objects (FulfillmentPackage)
id
required
string

A globally-unique identifier.

createdAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the shipment object was created.

status
required
string (ShipmentStatus)

Status of shipment

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be delivered.

required
Array of objects (FulfillmentShipmentItem)
shippedAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the entire shipment (all packages) was shipped to the buyer.

estimatedShipTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be shipped.

labelPrintTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the label was printed.

warehouseId
required
string

The id of the location (warehouse) that the shipment was processed at.

warehouseOrderId
string or null (Maybe_Scalars-at-String_)

The id of the order at the location (warehouse) that the shipment was processed at.

401

Unauthorized

404

Order not found

post/logistics/api/2024-04/orders/{orderId}/retry
Response samples
application/json
{
  • "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": [
      • {
        }
      ],
    • "message": "string",
    • "retriable": true,
    • "type": "PARTIALLY_SHIPPED"
    },
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "externalOrderId": "string",
  • "lineItems": [
    • {
      • "customsUnitValue": {
        },
      • "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": [
        ],
      • "id": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "status": "CANCELLED",
      • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
      • "lineItems": [
        ],
      • "shippedAt": "2019-08-24T14:15:22Z",
      • "estimatedShipTime": "2019-08-24T14:15:22Z",
      • "labelPrintTime": "2019-08-24T14:15:22Z",
      • "warehouseId": "string",
      • "warehouseOrderId": "string"
      }
    ]
}

CancelOrder

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.

SecurityBEARER
Request
path Parameters
orderId
required
string (OrderIdType) ^\d+$

A unique identifier for this order.

Responses
200

Ok

Response Schema: application/json
Any of:
required
object (Address)
address1
required
string

First address line of the address.

address2
string or null (Maybe_Scalars-at-String_)

Second address line of the address.

city
required
string

City of the address.

company
string or null (Maybe_Scalars-at-String_)

Company name for the entity.

countryCode
required
string

Country code for the address. Ex: 'US', 'CA', 'MX'.

name
string or null (Maybe_Scalars-at-String_)

Name of entity.

phone
required
string

Phone number of the entity.

provinceCode
required
string

State or region of the address - if a US countryCode, must be the 2-letter state postal abbreviation.

zip
required
string

Postal code of the 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_)
code
required
number <double>
Array of objects or null (Maybe_Array_LineItemError__)
message
required
string
retriable
required
boolean

Signals when an order error can be considered transient and can be retried manually by the caller. Attempting to create the order again will return a DUPLICATE_ORDER error, to retry please use the retry API.

type
required
string (OrderErrorType)
Enum: "PARTIALLY_SHIPPED" "BAD_ADDRESS" "BAD_PRODUCT_INFO" "CANNOT_SHIP_HAZMAT" "CARRIER_NETWORK_ERR" "DSKU_NEVER_INBOUNDED" "INTERNATIONAL_ADDRESS" "INVENTORY_ERR" "INVENTORY_TIMEOUT" "LABEL_PURCHASE_FAILURE" "MISSING_CUSTOMS_INFO" "MISSING_DDP_TAG" "MISSING_REMOVAL_FEE_SPECS" "MISSING_SHIPPING_SPECIFICATIONS_FOR_HAZMAT" "NON_PLT_ORDER_NOT_SUPPORTED" "NO_FEDEX_RATES" "NO_RATES" "NO_REMOVAL_PROPOSAL" "OVERSIZED_DIMS" "PARTIAL_FULFILL_FAILED" "PARTIAL_SHIP_UPDATE_FAILED" "PROMISE_TIME_EXPIRED" "REMOVALS_MINIMUM_NOT_MET" "REMOVAL_ON_HOLD" "STOCKOUT" "STOCKOUT_AT_INGESTION" "UNKNOWN" "UNKNOWN_SFP_STATUS" "UNREGISTERED_PRIME_PRODUCTS" "UNSUPPORTED_DESTINATION" "WAREHOUSE_ERR"
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.

Array
object or null (Maybe_Money_)
logisticsSku
required
string
quantity
required
number <double>
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.

Enum: "AMAZON" "BED_BATH_BEYOND" "BELK" "CHORD" "CHORD_ADMIN" "CHORD_FERMAT" "CHORD_GIFTING" "CHORD_SUBSCRIPTIONS" "CHORD_WHOLESALE_PORT" "CMS_SHOPIFY" "DELIVERR_API" "EBAY" "GO_TIME_GEAR" "JEST_TEST" "KENSIUM" "KOHLSUS_PROD" "KROGER" "LEASHBOSS" "LUSSOGEAR" "MACYS" "MAGENTO" "NETSUITE" "SHOPIFY" "SKUPREME" "SLEEPONITKIDS" "TARGET" "TIKTOK" "WALMART" "WEBSITE" "WOOCOMMERCE" "XTREMEBANDS"
required
object (OrderState)
fulfillmentDelayed
required
boolean
fulfillmentInProgress
required
boolean
fulfillmentStatus
required
string (ExternalOrderStatus)
Enum: "DELIVERED" "SHIPPED" "ROUTING_IN_PROGRESS" "STOPPED"
internalStatus
required
string (InternalOrderStatus)
Enum: "CANCELLED" "ERROR" "CREATED" "DELIVERED" "SHIPPED"
required
Array of objects (FulfillmentShipmentModel)
Array
required
Array of objects (FulfillmentPackage)
id
required
string

A globally-unique identifier.

createdAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the shipment object was created.

status
required
string (ShipmentStatus)

Status of shipment

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be delivered.

required
Array of objects (FulfillmentShipmentItem)
shippedAt
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the entire shipment (all packages) was shipped to the buyer.

estimatedShipTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) that the shipment is estimated to be shipped.

labelPrintTime
string or null <date-time> (Maybe_Scalars-at-Date_)

The date and time (ISO 8601 format) the label was printed.

warehouseId
required
string

The id of the location (warehouse) that the shipment was processed at.

warehouseOrderId
string or null (Maybe_Scalars-at-String_)

The id of the order at the location (warehouse) that the shipment was processed at.

401

Unauthorized

404

Order not found

post/logistics/api/2024-04/orders/{orderId}/cancel
Response samples
application/json
{
  • "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": [
      • {
        }
      ],
    • "message": "string",
    • "retriable": true,
    • "type": "PARTIALLY_SHIPPED"
    },
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "externalOrderId": "string",
  • "lineItems": [
    • {
      • "customsUnitValue": {
        },
      • "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": [
        ],
      • "id": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "status": "CANCELLED",
      • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
      • "lineItems": [
        ],
      • "shippedAt": "2019-08-24T14:15:22Z",
      • "estimatedShipTime": "2019-08-24T14:15:22Z",
      • "labelPrintTime": "2019-08-24T14:15:22Z",
      • "warehouseId": "string",
      • "warehouseOrderId": "string"
      }
    ]
}