Methods


Entity Properties


An order is a request from the merchant for an outbound shipment of the merchant’s inventory. Each order is closely tracked through picking and packing all of the way to the time it is placed on the carrier’s truck, even including which pallet the packages were loaded onto. When an order has begun picking it is split (if needed) into “Shipments” based on the most efficient way to meet carrier size and weight limitations. Each “shipment” therefore typically results in only one package although under some circumstances may still require more than one package.

Order States and Statuses

new
Order received and inventory reserved.
Valid statuses: new, partial_backorder, backordered
processing
Shipments created and assigned to a picking batch.
Valid statuses: processing, partial_backorder
complete
Entire order has been packaged and labeled for shipping.
Valid statuses: complete
canceled
Order has been canceled. Valid statuses: canceled
holded
Order is on hold.
Valid statuses: holded, delayed_shipment

order.create

order.create (string|null $storeCode, object $items, object $address, object $info)

Create a new order. This operation will only be successful if the inventory is available and the unique_id is unique (if specified).

Parameters

0 string|null
Store code. If not specified will default to the configured default store. Merchants with multiple stores may specify which store the order belongs to.
1 object
Order Items. Three possible formats:
{ "product1's_SKU": 1, "product2's_SKU": 3 }
[ { "sku": "product1", "qty": 1 }, { "sku": "product2", "qty": 3 } ]
[ { "sku": "product1", "qty": 1, "unit_declared_value": "20.40" }, {...} ]
2 object
Shipping Address (see “Shipping Address Properties”)
3 object
Order Additional Data (see “Order Additional Data”)

Order Items Data

sku
Use to specify the SKU of the item being ordered.
qty
Use to specify the quantity being ordered of a particular item.
order_item_ref
If required by your integration you may specify a reference to an external order item id.
unit_declared_value
Specifiy a declared unit value in USD. Specifying the unit declared value is preferred over specifying only the entire order declared value so that an accurate amount can be computed for partial fulfillments.

Order Additional Data

unique_id
This field is optional and if not specified an auto-incrementing number will be assigned. Uniqueness based on this field is enforced so an error will be given if an order with the same unique_id already exists.

This ‘unique_id’ is the id used for other API calls such as “order.info”.

order_ref
This field is optional and if not specified will be left blank. Uniqueness based on this field is not enforced (two orders may have the same order_ref value). If specified, this number will appear on packing slips in place of the unique_id.
shipping_method
See the Shipping Methods document for a reference. Is not optional.
custom_greeting
If specified will override the configured default greeting.
note
The “Note” adds a status history to the order that only you and the warehouse staff may see. Adding a note will not affect the way the order is picked and packed and is not required.
signature_required
If “adult” then the package(s) will be shipped with the Adult Signature Required option (21 years or older). If “any” then the package(s) will be shipped with the “Direct” signature required (recipient of any age). If “indirect” then the package(s) will be shipped with the “Indirect” signature required (if “Indirect” is not supported by the carrier, this option will fall back to ‘any’). The value “default” may be used to defer to the default based on carrier service type. If not specified will default to “default” for HazMat orders or “none” for others.
saturday_delivery
Saturday delivery option. If not specified will default to ‘false’.
reason_for_export
Reason for export. Values can be sold, not_sold, gift, sample, repair_return, personal_effects. If not specified will default to sold. Only applicable to international orders.
declared_value_service
If ‘true’ then the order or the package(s) will be shipped with declared_value_service requested. Only the unit_declared_value must be specified for at least one SKU or declared_value for the order, but not both. If not specified will default to ‘false’.
declared_value
Needs to be set if "declared_value_service": true and "unit_declared_value" is not set on any individual product SKU being ordered. e.g. "declared_value": "40.50"
overbox
Request overbox option. If not specified will default to ‘false’.
backorder_policy
If specified, sets this order’s backorder policy. Order will use specified policy instead of store’s default policy. Values can be default, all_or_nothing, as_available, or up_to_X. If not specified will default to "default".
all_or_nothing - Accept order but do not ship anything until all items are in stock.
as_available - No limit to number or frequency of additional shipments.
up_to_X shipments - Same as "As Available", but changes to All or Nothing before shipping Xth shipment.
When using up_to_X, “X” represent a positive integer number. Example: { "backorder_policy": "up_to_3" }
priority
If specified, sets this order’s priority. Setting the priority will boost or suppress this order’s priority in relation to other orders for the same products. Valid input are values in the range 0 -100. Lower numbers are higher in priority. If not specified will default to 50.
requested_ship_date
If specified, the requested ship date will determine if the merchant wishes for the item to be shipped on the same day or not. Whether or not this date becomes the Target Ship Date depends on the merchant’s target ship date cutoff time and the time the order is placed.

Format: YYYY-MM-DD

delayed_ship_date
If specified, the order will be placed in “hold” status until this date.

Format: YYYY-MM-DD

desired_delivery_date
Required for the Cheapest On-Time shipping method.

Format: YYYY-MM-DD

hold_indefinitely
If specified, the order will be placed in “hold” status indefinitely (cannot be used with delayed_ship_date).
tpb_group_id
The ID number of a Third Party Billing Account Group. If unset or null, and a default group is configured, the default group will be used. Set to 0 to disable third party billing.
instructions
Array of order instructions. See “Order Instruction”.

Return Value

An object with the new order’s Order Properties.

Example Request

Create new order:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.create",
        [
            "rsf",
            {
                "product2" : 5
            },
            {
                "firstname" : "Bill",
                "lastname" : "Gates",
                "company" : "Microsoft",
                "street1" : "11 Times Square",
                "city" : "New York",
                "region" : "NY",
                "postcode" : "10036",
                "country" : "US",
                "telephone" : "212.245.2100"
            },
            {
                "order_ref" : "12345",
                "shipping_method" : "ups_03",
                "custom_greeting" : "Greeting text here",
                "note" : "Note text here",
                "signature_required" : "none",
                "saturday_delivery" : false,
                "declared_value_service" : false,
                "overbox" : false,
                "requested_ship_date" : "2014-07-28"
            }
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "order_id" : 117,
        "unique_id" : "100000017",
        ...
    }
}

Error Codes

code message
102 Invalid data given. Details in error message.
104 An order with the specified ID already exists.
106 Invalid script given. Details in error message.
107 Product does not exist.

order.edit

order.edit (string $orderUniqueId, object $address, object $info)

Modify the Shipping Address and/or the Order Additional Data for the existing order.

Parameters

0 string|null
Order unique ID.
1 object
Shipping Address (see “Address Properties”)
2 object
Order Additional Data (see “Order Additional Data”)

Return Value

An object with the updated order’s Order Properties.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.edit",
        [
            "100000309",
            {
                "firstname" : "Bill",
                "lastname" : "Gates"
            },
            {
                "shipping_method" : "ups_03"
            }
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "order_id" : 118,
        "unique_id" : "100000309",
        ...
    }
}

Error Codes

code message
102 Invalid data given. Details in error message.
105 The order cannot be edited.

order.search

order.search (null|object $filters, array $options = [], null|string|object $fields = [])

Retrieve list of orders by filters. Order data can be customized by specifying properties to retrieve.

Parameters

0 null|object
Filters to apply for the search.
  • null - Retrieve list of all orders.
  • object - Retrieve list of orders using specified “Search Filters”.
1 null|object
Options to apply for the search.
  • null - No options will be applied.
  • object - Apply specified “Search Options”.
2 null|string|object
Specify which fields should be included in the response.
  • null - Retrieve only “order_id”, “unique_id”, and “order_ref” properties.
  • string - The string '*' denotes all properties excluding “shipping_address”, “items”, “shipments”, “tracking_numbers”, “packages”, and “status_history”.
  • object - List of properties to retrieve in addition to “order_id”, “unique_id”, and “order_ref”. List may include ‘*’.

Example:

["*", "shipping_address"]

See “Order Properties”.

Return Value

An array of objects. Each object will contain the specified (or default if no fields parameter was given) “Order Properties”.

Example Request

Get order status and order items for two order ids:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.search",
        [
            {
                "order_id" : {
                    "in" : [
                        114,
                        115
                    ]
                }
            },
            null,
            [
                "status",
                "items"
            ]
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "order_id" : 114,
            "unique_id" : "100000114",
            "order_ref" : null,
            "status" : "picking",
            "items" : [
                {
                    "sku" : "product2",
                    "name" : "product2",
                    "weight" : 12.0000,
                    "row_weight" : 12.0000,
                    "qty_ordered" : 12.0000,
                    "qty_processing" : 1.0000,
                    "qty_shipped" : 0.0000,
                    "qty_canceled" : 0.0000,
                    "qty_backordered" : 11.0000,
                    "package_data" : [
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                    ]
                },
                {
                    "sku" : "product1",
                    "name" : "product1",
                    "weight" : 1.2300,
                    "row_weight" : 1.2300,
                    "qty_ordered" : 12.0000,
                    "qty_processing" : 1.0000,
                    "qty_shipped" : 0.0000,
                    "qty_canceled" : 0.0000,
                    "qty_backordered" : 11.0000,
                    "package_data" : [
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                    ]
                }
            ]
        },
        {
            "order_id" : 115,
            "unique_id" : "100000116",
            "order_ref" : null,
            "status" : "picked",
            "items" : [
                {
                    "sku" : "product2",
                    "name" : "product2",
                    "weight" : 12.0000,
                    "row_weight" : 12.0000,
                    "qty_ordered" : 12.0000,
                    "qty_processing" : 1.0000,
                    "qty_shipped" : 0.0000,
                    "qty_canceled" : 0.0000,
                    "qty_backordered" : 11.0000,
                    "package_data" : [
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                    ]
                },
                {
                    "sku" : "product1",
                    "name" : "product1",
                    "weight" : 1.2300,
                    "row_weight" : 1.2300,
                    "qty_ordered" : 12.0000,
                    "qty_processing" : 1.0000,
                    "qty_shipped" : 0.0000,
                    "qty_canceled" : 0.0000,
                    "qty_backordered" : 11.0000,
                    "package_data" : [
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                    ]
                }
            ]
        }
    ]
}

Error Codes

code message
101 Invalid filters given. Details in error message.

order.info (string $orderUniqueId, null|string|object $fields = [])

Retrieve full order information.

Parameters

0 string
Order unique ID.
1 null|string|object
Specify which fields should be included in the response.
  • null - Retrieve only “order_id”, “unique_id”, and “order_ref” properties.
  • string - The string '*' denotes all properties excluding “shipping_address”, “items”, “shipments”, “tracking_numbers”, “packages”, and “status_history”.
  • object - List of properties to retrieve in addition to “order_id”, “unique_id”, and “order_ref”. List may include ‘*’.

Example:

["*", "shipping_address"]

See “Order Properties”.

Return Value

Object which contains the specified (or default if no fields parameter was given) “Order Properties”.

Example Request

Get order information for the specified order:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.info",
        [
            "100000114",
            [
                "status",
                "items"
            ]
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "order_id" : 114,
        "unique_id" : "100000114",
        "order_ref" : null,
        "status" : "picking",
        "items" : [
            {
                "sku" : "product2",
                "name" : "product2",
                "weight" : 12.0000,
                "row_weight" : 12.0000,
                "qty_ordered" : 12.0000,
                "qty_processing" : 1.0000,
                "qty_shipped" : 0.0000,
                "qty_canceled" : 0.0000,
                "qty_backordered" : 11.0000,
                "package_data" : [
                    {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                    {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                ]
            },
            {
                "sku" : "product1",
                "name" : "product1",
                "weight" : 1.2300,
                "row_weight" : 1.2300,
                "qty_ordered" : 12.0000,
                "qty_processing" : 1.0000,
                "qty_shipped" : 0.0000,
                "qty_canceled" : 0.0000,
                "qty_backordered" : 11.0000,
                "package_data" : [
                    {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                    {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                ]
            }
        ]
    }
}

Error Codes

code message
100 Requested order does not exist.

order.hold (string $orderUniqueId)

Hold an existing order. This operation will only be successful if the order exists and can be holded.

Parameters

orderdescription
0 string - Order unique ID.

Return Value

true if the order was holded.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.hold",
        [
            "100000112"
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : true
}

Error Codes

code message
100 Requested order does not exist.
103 Order status not changed. Details in error message.

order.unhold (string $orderUniqueId)

Unhold an existing order. This operation will only be successful if the order exists and can be unholded.

Parameters

orderdescription
0 string - Order unique ID.

Return Value

true if the order was unholded.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.unhold",
        [
            "100000112"
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : true
}

Error Codes

code message
100 Requested order does not exist.
103 Order status not changed. Details in error message.

order.cancel

order.cancel (string $uniqueOrderId, array $options, null|string|object $fields = [])

Cancel an existing order. This operation will only be successful if the order exists, and at least one of the cancellation options is permitted for the order’s current status and the store configuration.

Parameters

0 string
string - Order unique ID
1 object
A list of the following properties, at least one of which must be set to true.
  • backordered_items - If the order has back ordered items, attempt to cancel them. If all items on the order are back ordered, then the entire order will be canceled.
  • unfulfilled_items - If the order has unfulfilled items, attempt to cancel them. If all items on the order are unfulfilled, then the entire order will be canceled. An unfulfilled item is an item that has not yet been added to a shipment for picking, including backordered items.
  • all_items - Attempt to cancel the entire order. If the order state is processing or complete then you will only be able to cancel the order if the store configuration allows it. If any items on the order have been fulfilled, then you must also set cancellation_request to true.
  • cancellation_request - If the all_items option is not available, you can use this option send a cancellation request instead.

Example:

     {
         "backordered_items" : true,
         "unfulfilled_items" : false,
         "all_items" : false,
         "cancellation_request" : false
     }
2 null|string|object
Specify which fields should be included in the order object returned in the response.
  • null - Retrieve only “order_id”, “unique_id”, and “order_ref” properties.
  • string - The string '*' denotes all properties excluding “shipping_address”, “items”, “tracking_numbers” and “status_history”.
  • object - List of properties to retrieve in addition to “order_id”, “unique_id”, and “order_ref”. List may include ‘*’.

Example:

["*", "shipping_address"]

See “Order Properties”.

Return Value

An object containing the following properties:

bool success
If at least one of the cancellation options was successful, the value will be true
array warnings
An array of warning messages
array cancellations
An array of delivery ID numbers for any newly created cancellation requests
object order
Contains the specified (or default if no fields parameter was given) “Order Properties”.

Example Request

Attempt to cancel all items on an order:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order.cancel",
        [
            "100000114",
            {
                "all_items": true
            }
        ],
        ["status", "items"]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "success": false,
        "warnings": [
            "Order contains fulfilled items, please set the \"cancellation_request\" option to \"true\" and try again"
        ],
        "cancellations": [ ],
        "order": {
            "order_id" : 114,
            "unique_id" : "100000114",
            "order_ref" : null,
            "status" : "complete",
            "items" : [
                {
                    "sku" : "product2",
                    "name" : "product2",
                    "weight" : 12.0000,
                    "row_weight" : 12.0000,
                    "qty_ordered" : 12.0000,
                    "qty_processing" : 0.0000,
                    "qty_shipped" : 12.0000,
                    "qty_canceled" : 0.0000,
                    "qty_backordered" : 0.0000,
                    "package_data" : [
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
                        {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
                    ]
                }
            ]
        }
    }
}

Error Codes

code message
100 Requested order does not exist.
102 Invalid data given. Details in error message.
103 Order status not changed. Details in error message.

Entity Properties

Order Properties

order_id The internal order ID.
unique_id The unique id for the order. This will be auto-assigned if not specified by the merchant at order creation time.
This "unique_id" is the ID used for other API calls such as "order.info".
order_ref An optional merchant-supplied reference for the order. Not a unique identifier.
state State
status Status
store_code Store Code
store_name Store Name
carrier_code Carrier Code
shipping_method Shipping Description
shipping_description Shipping Description
carrier_changed Flag to identify whether carrier was changed.
is_address_modified Flag to identify whether address was modified.
is_address_modified_auto Flag to identify whether address was modified automatically.
weight Weight
total_item_count Amount of order items.
remote_ip Remote IP Address
signature_required Flag to identify whether signature is required.
saturday_delivery Flag to identify saturday delivery.
reason_for_export Reason for export. Values can be sold, not_sold, gift, sample, repair_return, personal_effects. If not specified will default to sold. Only applicable to international orders.
overbox Flag to identify overbox.
backorder_policy This order's backorder policy. Order will use specified policy instead of store's default policy. Values can be default, all_or_nothing, as_available, or up_to_X. Default value is default.
all_or_nothing - Accept order but do not ship anything until all items are in stock.
as_available - No limit to number or frequency of additional shipments.
up_to_X shipments - Same as "As Available", but changes to All or Nothing before shipping Xth shipment.
When using up_to_X, "X" represent a positive integer number. Example: { "backorder_policy": "up_to_3" }
priority This order's priority. Setting the priority will boost or suppress this order's priority in relation to other orders for the same products. Valid input are values in the range 0 - 100. The default value is 50. Lower numbers are higher in priority.
estimated_packages Estimated number of packages.
target_ship_date Date when the order will be shipped.
requested_ship_date Date when the order was requested to be shipped.
custom_greeting Custom greeting message if specified during order creation.
gift_message Gift Message
declared_value Order declared value. Only the order declared value or order item unit declared value may be specified, but not both.
tpb_group_id The ID number of a Third Party Billing Account Group. If unset or null, and a default group is configured, then the default group will be used. Set to 0 to disable third party billing.
created_at Date and time when the order was created in ISO 8601 format.
updated_at Date and time when the order was updated in ISO 8601 format.
completed_at Date and time when the order was completed in ISO 8601 format.
shipping_address The shipping address. See "Shipping Address Properties".
items Array of order items. See "Order Item Properties".
shipments Array of shipments. Only the "shipment_id" and the "status" fields are present in the Order API. Use the Shipment API to retrieve full shipment details.
tracking_numbers Array of tracking numbers. See "Tracking Number Properties". This property is deprecated - please use "packages" instead).
packages Array of packages. See "Package Properties".
status_history Array of history statuses. See "Status History".

Order Instructions

note
{ "note" : "Place Amazon FBA Label in a pouch" }
The "Note" property. This is required.
file_name
{ "file_name" : "amazon_fba_3425232.pdf" }
The "File Name" property.
file_content
{ "file_content" : "base64 encoded file content" }
The base64 encoded "File Content" property.
presentation
{ "presentation" : "once_per_order" }
The "Presentation" property. Values can be once_per_order, once_per_shipment, or once_per_package.
print_target
{ "print_target" : "LABEL" }
The "Print Target" property. Values can be LABEL, SMALL_LABEL, or LASER.
Single Instruction Example:
"instructions": [
    {
        "note"         : "Place Amazon FBA Label in a pouch"
        "file_name"    : "amazon_fba_3425232.pdf",
        "file_content" : "base64 encoded file content",
        "presentation" : "once_per_shipment",
        "print_target" : "LABEL"
    }
]
Multiple Instructions example:
"instructions": [
    {
        "note"         : "Place Amazon FBA Label in a pouch",
        "file_name"    : "amazon_fba_3425232.pdf",
        "file_content" : "base64 encoded file content",
        "presentation" : "once_per_shipment",
        "print_target" : "LABEL"
    },
    {
        "note"         : "Place Flier in Package"
        "file_name"    : "flier_3425232.pdf",
        "file_content" : "base64 encoded file content",
        "presentation" : "once_per_package",
        "print_target" : "LASER"
    },
]
Full order.create Example:
    {
        "jsonrpc" : 2.0,
        "id"      : 1234,
        "method"  : "call",
        "params"  : [
            "be1c13ed4e03f0ed7f1e4053dfff9658",
            "order.create",
            [
                "rsf",
                {
                    "product2" : 5
                },
                {
                    "firstname" : "Bill",
                    "lastname"  : "Gates",
                    "company"   : "Microsoft",
                    "street1"   : "11 Times Square",
                    "city"      : "New York",
                    "region"    : "NY",
                    "postcode"  : "10036",
                    "country"   : "US",
                    "telephone"     : "212.245.2100"
                },
                {
                    "order_ref"              : "12345",
                    "shipping_method"        : "ups_03",
                    "custom_greeting"        : "Greeting text here",
                    "note"                   : "Note text here",
                    "signature_required"     : "none",
                    "saturday_delivery"      : false,
                    "declared_value_service" : false,
                    "overbox"                : false,
                    "requested_ship_date"    : "2014-07-28",
                    "instructions"           : [
                         {
                            "note"         : "Place Amazon FBA Label in a pouch",
                            "file_name"    : "amazon_fba_3425232.pdf",
                            "file_content" : "base64 encoded file content",
                            "presentation" : "once_per_shipment",
                            "print_target" : "LABEL"
                        },
                        {
                            "note"         : "Place extra padding between products and around edges.",
                            "presentation" : "once_per_package"
                        }
                    ]
               }
            ]
        ]
    }

Order Item Properties

order_item_id
{ "order_item_id" : 524 }
The "Order Item ID" is a unique identifier for the order item.
order_item_ref
{ "order_item_ref" : "10" }
The "Order Item Ref" is an optional user-supplied value for the order item.
sku
{ "sku" : "product1" }
The "SKU" property.
name
{ "name" : "product 1" }
The "Name" property.
weight
{ "weight" : 1.75 }
The "Weight" property.
row_weight
{ "row_weight" : 3.5 }
Total order item weight.
qty_ordered
{ "qty_ordered" : 3 }
Amount of ordered products.
qty_processing
{ "qty_processing" : 0 }
Amount of processing products.
qty_shipped
{ "qty_shipped" : 3 }
Amount of shipped products.
qty_canceled
{ "qty_canceled" : 0 }
Amount of canceled products.
qty_backordered
{ "qty_backordered" : 11 }
Amount of backordered products.
allocation_data
[
  {"warehouse_id" : 1, "qty_allocated" : "2.000"},
  {"warehouse_id" : 2, "qty_allocated" : "1.000"}
]
The allocation quantity for each warehouse.
package_data
[
  {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
  {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
]
The "Package Data" property.

Address Properties

firstname
{ "firstname" : "Gates" }
The "First Name" property.
lastname
{ "lastname" : "Bill" }
The "Last Name" property.
company
{ "company" : "Microsoft" }
The "Company" property.
street
{ "street" : "11 Times Square\nc/oSteve Ballmer" }
The street address. Multi-line street addresses will be separated by a newline ("\n") character. Only two address lines are supported.
city
{ "city" : "New York" }
The "City" property.
region
{ "region" : "NY" }
The "Region" property.
postcode
{ "postcode" : "10036" }
The "Postal Code" property. Pass as a string to prevent leading 0s from being dropped.
country
{ "country" : "US" }
The "Country" property.
classification
{ "classification" : "com" }
The "Classification" property. Allowed: "res" - residential, "com" - commercial, "unk" - unknown.
is_valid
{ "is_valid" : 1 }
Flag whether address is valid.
telephone
{ "telephone" : "212.245.2100" }
The "Telephone" property.
email
{ "email" : "customer@example.com" }
The "Email" property.

Package Properties

warehouse_id
{ "warehouse_id" : "1" }
The ID of the warehouse associated with the package.
status
{ "status" : "not_on_manifest" }
The "Status" property. Allowed values: not_on_manifest, on_manifest, on_truck, received_by_carrier.
shipment_id
{ "shipment_id" : "100000005" }
The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #" and is used for the Shipment API calls.
shipment_status
{ "shipment_status" : "packing" }
The "Shipment Status" property. Allowed values: picking, picked, packing, packed, loaded.
carrier
{ "carrier" : "ups" }
Carrier code.
timestamp
{ "timestamp" : "2019-01-14T14:29:31+00:00" }
The date and time when the package was created in ISO 8601 format.
weight
{ "weight" : "16.900" }
The weight of the package.
weight_units
{ "weight_units" : "POUND" }
The unit of measure used for weight.
dimensions
{ 
    "dimensions" : {
        "length": "16.000",
        "width": "12.000",
        "height": "8.000"
    } 
}
The length, width, and height of the package.
dimension_units
{ "dimension_units" : "INCH" }
The unit of measure used for dimensional measurement.
tracking
[
    { 
        "number" : "1Z49R7V80308849438", 
        "description" : "UPS Ground" 
    }, { 
        "number" : "1Z49R7V29475663003", 
        "description" : "UPS Ground" 
    }
]
An array of tracking objects.
The "number" property contains the tracking number.
The "description" property contains the shipping method name.
order_items
[
    {
        "order_item_id" : "117",
        "order_item_ref" : "10",
        "sku: "product1",
        "quantity: "2.0000"
    }, {
        "order_item_id" : "118",
        "order_item_ref" : null,
        "sku: "product2",
        "quantity: "2.0000"
    } 
]
An array of order items contained in the package. These items may be different from those in "package_items" if the order was fulfilled using a Bill of Materials.

"order_item_id" is the unqiue identifier for the order item.
"order_item_ref" is an optional user supplied reference for the order item.
"sku" is the order item's SKU.
"quantity" is the quantity of the order item in the package.
package_items
[
    {
        "order_item_id" : "117",
        "sku: "product1",
        "quantity: "2.0000" 
    }, {
        "order_item_id" : "118",
        "sku: "product2",
        "quantity: "2.0000"
    }
] 
An array of items contained in the package. These items may be different from those in "order_items" if the order was fulfilled using a Bill of Materials.

"order_item_id" is the unqiue identifier of the related order item.
"sku" is the package item's SKU.
"quantity" is the quantity of the item in the package.
package_data
[
    {
        "order_item_id: "117", 
        "label" : "Serial Number - 8 Characters", 
        "value" : "55285368"
    }, {
       "order_item_id: "118", 
       "label" : "Serial Number - 8 Characters", 
       "value" : "55285369"
   }
]
The "Package Data" property.

Tracking Number Properties

This entity is deprecated, please use Package instead.

shipment_id
{ "shipment" : "100000005" }
The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #" and is used for the Shipment API calls.
carrier
{ "carrier" : "ups" }
Carrier code.
carrier_name
{ "carrier_name" : "United Parcel Service" }
The carrier name.
description
{ "description" : "Ground" }
The method description (without the carrier name).
number
{ "number" : "1Z9999999999999999" }
Tracking number.
date
{ "date" : "2014-07-30T18:52:30+00:00" }
The date and time when the shipping label was created in ISO 8601 format.
items
[
    {"sku" : "product1", "quantity" : 1 },
    {"sku" : "product2", "quantity" : 1 }
]
SKUs and quantities of the related package items.

Status History

status
{ "status" : "picked" }
The "Status" property.
comment
{ "comment" : "Shipping address classified as Commercial" }
The "Comment" property.
created_at
{ "created_at" : "2014-07-24T18:51:34+00:00" }
The "Created At" property in ISO 8601 format.