Methods


Entity Properties


A delivery is an inbound shipment of your product to RSF. It could be an “ASN” (Advanced Shipment Notification), an “RMA” (Return Merchandise Authorization) or an “Other Delivery” (anything other than an ASN or RMA). They are all processed similarly regardless of which type of delivery is specified. Processing involves the general stages of “Accepting” the container from the carrier and weighing it, “Processing” the containers to align what was expected with what was actually received, “Putting Away” the processed inventory and “Committing” the put-away inventory to the available inventory. “Accepting” stage results with “Accepted” or “Ready To Process” delivery status. If the delivery has items on it before it is accepted, “Ready To Process” status is set and “Accepted” status skipped. Most of these steps happen automatically depending on the merchant’s configuration and whether or not there are any exceptions (discrepancies between expected and received).

delivery.search (null|object $filters, array $options = [])

Retrieve list of deliveries. Filtration could be applied.

Parameters

</td>
orderdescription
0
  • null - Retrieve list of all deliveries.
  • object - Retrieve list of deliveries using specified filters.
Allowed properties for filtering: "delivery_id", "increment_id", "warehouse_id", "merchant_ref", "merchant_status", "total_skus", "delivery_type", "status", "sender_name", "expected_delivery", "sender_ref", "sender_ref_alt", "created_at", "updated_at", "comments", "tracking_numbers".
1
  • null - No options will be applied.
  • object - Apply specified options.

Return Value

An array of objects. Each object will contain “Delivery Properties”.

Example Request

Get delivery for one delivery id:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.search",
        [
            {
                "delivery_id" : {
                    "eq" : 1
                }
            },
            []
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "results" : [
            {
                "delivery_id" : 1,
                "warehouse_id" : 1,
                "increment_id" : "1000036",
                "delivery_type" : "asn",
                "state" : "complete",
                "status" : "put_away",
                "before_hold_state" : null,
                "before_hold_status" : null,
                "progress" : 100,
                "total_skus" : 2,
                "sender_name" : "Microsoft",
                "carrier_name" : "FedEx",
                "expected_delivery" : "2014-06-26",
                "delivered_at" : "2014-07-21T08:52:56+00:00",
                "ready_to_process_at" : "2014-07-21T08:52:56+00:00",
                "processed_at" : "2014-07-21T09:22:36+00:00",
                "putaway_at" : "2014-07-21T11:24:05+00:00",
                "completed_at" : null,
                "comments" : null,
                "merchant_ref" : null,
                "merchant_status" : null,
                "sender_ref" : null,
                "sender_ref_alt" : null,
                "num_containers" : 2,
                "num_labels" : 1,
                "total_container_weight" : null,
                "total_container_weight_unit" : null,
                "total_product_weight" : null,
                "total_product_weight_unit" : null,
                "special_requirements" : null,
                "auto_commit" : null,
                "created_at" : "2014-06-26T13:47:47+00:00",
                "updated_at" : "2014-06-26T14:09:30+00:00",
                "items" : [
                    {
                        "delivery_item_id" : 1,
                        "delivery_id" : 1,
                        "product_id" : 214,
                        "qty" : 1,
                        "qty_expected" : 0,
                        "qty_received" : 1,
                        "qty_shortage" : 0,
                        "qty_overage" : 5,
                        "qty_processed" : 1,
                        "qty_putaway" : 1,
                        "qty_committed" : 0,
                        "sku" : "product2"
                    },
                    {
                        "delivery_item_id" : 2,
                        "delivery_id" : 1,
                        "product_id" : 213,
                        "qty" : 1,
                        "qty_expected" : 0,
                        "qty_received" : 1,
                        "qty_shortage" : 0,
                        "qty_overage" : 0,
                        "qty_processed" : 1,
                        "qty_putaway" : 1,
                        "qty_committed" : 0,
                        "sku" : "product1"
                    }
                ],
                "containers" : [
                    {
                        "container_id" : 1,
                        "delivery_id" : 1,
                        "container_type_id" : 1,
                        "damage_type" : "none",
                        "weight_discrepancy" : "none",
                        "tare_weight" : 1,
                        "tare_weight_unit" : "lb",
                        "weight" : 8,
                        "weight_unit" : "lb",
                        "weighed_at" : "2014-06-26T13:49:04+00:00",
                        "weighed_by" : 1,
                        "contents" : [
                            {
                                "delivery_item_id": 1,
                                "qty_counted": 6,
                                "qty_shortage": 0
                            }
                        ],
                        "notes" : null
                    },
                    {
                        "container_id" : 2,
                        "delivery_id" : 1,
                        "container_type_id" : 1,
                        "damage_type" : "none",
                        "weight_discrepancy" : "none",
                        "tare_weight" : 1,
                        "tare_weight_unit" : "lb",
                        "weight" : 3,
                        "weight_unit" : "lb",
                        "weighed_at" : "2014-06-26T13:49:15+00:00",
                        "weighed_by" : 1,
                        "contents" : [
                            {
                                "delivery_item_id": 2,
                                "qty_counted": 1,
                                "qty_shortage": 0
                            }
                        ],
                        "notes" : null
                    }
                ],
                "exceptions" : [
                    {
                        "delivery_exception_id" : 1,
                        "delivery_id" : 1,
                        "delivery_item_id" : 1,
                        "container_id" : 2,
                        "status" : "pending",
                        "sign" : 1,
                        "reason" : "overage_counted",
                        "comment" : null,
                        "qty" : 5
                    }
                ]
            }
        ],
        "totalCount" : 1,
        "numPages" : 1
    }
}

Error Codes

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

delivery.create (number $deliveryType, object $data, null|array $items = null)

Create delivery.

Parameters

orderdescription
0 string - Delivery type. Allowed: "asn", "rma", "other".
1 object - Delivery data. See Delivery Properties.
2
  • null - Create delivery without items.
  • array - Array of objects with two properties: "sku" and "qty".

Return Value

Delivery information.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.create",
        [
            "asn",
            {
                "warehouse_id" : 1,
                "auto_commit" : true,
                "sender_name" : "Bill Gates",
                "carrier_name" : "FedEx",
                "expected_delivery" : "2014-07-31",
                "merchant_ref" : "Inv 12345"
            },
            [
                {
                    "sku" : "product1",
                    "qty" : 5
                },
                {
                    "sku" : "product2",
                    "qty" : 1
                }
            ]
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "delivery_id" : 4,
        "increment_id" : "1000039",
        "delivery_type" : "asn",
        "state": "new",
        "status": "new",
        "before_hold_state": null,
        "before_hold_status": null,
        "progress": 0,
        "total_skus": 1,
        "sender_name" : "Bill Gates",
        "carrier_name" : "FedEx",
        "expected_delivery" : "2014-07-31",
        "delivered_at": null,
        "ready_to_process_at": null,
        "processed_at": null,
        "putaway_at": null,
        "completed_at": null,
        "comments": null,
        "merchant_ref" : 12345,
        "merchant_status": null,
        "sender_ref": null,
        "sender_ref_alt": null,
        "num_containers": null,
        "num_labels": 0,
        "total_container_weight": null,
        "total_container_weight_unit": null,
        "total_product_weight": null,
        "total_product_weight_unit": null,
        "special_requirements": null,
        "auto_commit": 2,
        "created_at" : "2014-07-31T14:10:00+00:00",
        "updated_at" : "2014-07-31T14:10:00+00:00",
        "warehouse_id" : 1
    }
}

Error Codes

code message
107 Error creating the delivery. Details in error message.

delivery.labels (string $incrementId, null|array $fields = [])

Retrieve list of labels for the given delivery.

Parameters

orderdescription
0 Delivery increment id
1
  • null - Basic label data.
  • array - Array of fields. Allowed: "packages", "destination_address", "origin_address"

Return Value

An array of objects. Each object will contain “Delivery Label Properties”.

Example Request

Get labels for the delivery:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.labels",
        [
            "1000055",
            [
                "packages",
                "destination_address",
                "origin_address"
            ]
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result": [
        {
            "label_id": "8",
            "delivery_id": "26",
            "warehouse_id": "1",
            "status": "valid",
            "shipping_label": "ups_03",
            "created_at": "2021-01-20T10:03:55+00:00",
            "updated_at": "2021-01-20T10:04:01+00:00",
            "packages": [
                {
                    "warehouse_id": "1",
                    "label_id": "8",
                    "carrier": "ups",
                    "weight": "18.000",
                    "weight_unit": "lb",
                    "dimensions": {
                        "length": "10.000",
                        "width": "11.000",
                        "height": "12.000"
                    },
                    "dimension_unit": "in",
                    "tracking": [
                        {
                            "number": "1Z49R7V89024431506",
                            "description": "UPS Ground"
                        }
                    ],
                    "package_items": [
                        {
                            "delivery_item_id": 2,
                            "sku": "O-VS-Oregano-p3",
                            "quantity": "4.000"
                        },
                        {
                            "delivery_item_id": 3,
                            "sku": "O-VS-Mint-p2",
                            "quantity": "4.000"
                        },
                        {
                            "delivery_item_id": 5,
                            "sku": "VS-Bags-p1",
                            "quantity": "4.000"
                        }
                    ]
                }
            ],
            "destination_address": {
                "region": "New York",
                "postcode": "13088",
                "lastname": "Marquez",
                "street": "4616 Crossroads Park Dr",
                "city": "Liverpool",
                "email": null,
                "telephone": "865-971-4663",
                "firstname": "Sherlock",
                "company": null,
                "classification": "com",
                "is_valid": null,
                "country": "US"
            },
            "origin_address": {
                "region": "New York",
                "postcode": "10036",
                "lastname": "Gates",
                "street": "11 Times Square",
                "city": "New York",
                "email": null,
                "telephone": "212.245.2100",
                "firstname": "Bill",
                "company": "Microsoft",
                "classification": null,
                "is_valid": null,
                "country": "US"
            }
        },
        {
            "label_id": "9",
            "delivery_id": "26",
            "warehouse_id": "1",
            "status": "valid",
            "carrier": "ups",
            "created_at": "2021-01-20T10:04:23+00:00",
            "updated_at": "2021-01-20T10:04:26+00:00",
            "packages": [
                {
                    "warehouse_id": "1",
                    "label_id": "9",
                    "carrier": "ups",
                    "weight": "27.000",
                    "weight_unit": "lb",
                    "dimensions": {
                        "length": "10.000",
                        "width": "11.000",
                        "height": "12.000"
                    },
                    "dimension_unit": "in",
                    "tracking": [
                        {
                            "number": "1Z49R7V89021837511",
                            "description": "UPS Ground"
                        }
                    ],
                    "package_items": [
                        {
                            "delivery_item_id": 2,
                            "sku": "O-VS-Oregano-p3",
                            "quantity": "6.000"
                        },
                        {
                            "delivery_item_id": 3,
                            "sku": "O-VS-Mint-p2",
                            "quantity": "6.000"
                        },
                        {
                            "delivery_item_id": 5,
                            "sku": "VS-Bags-p1",
                            "quantity": "6.000"
                        }
                    ]
                }
            ],
            "destination_address": {
                "region": "New York",
                "postcode": "13088",
                "lastname": "Marquez",
                "street": "4616 Crossroads Park Dr",
                "city": "Liverpool",
                "email": null,
                "telephone": "865-971-4663",
                "firstname": "Sherlock",
                "company": null,
                "classification": "com",
                "is_valid": null,
                "country": "US"
            },
            "origin_address": {
                "region": "New York",
                "postcode": "10036",
                "lastname": "Gates",
                "street": "11 Times Square",
                "city": "New York",
                "email": null,
                "telephone": "212.245.2100",
                "firstname": "Bill",
                "company": "Microsoft",
                "classification": null,
                "is_valid": null,
                "country": "US"
            }
        }
    ]
}

Error Codes

code message
100 Requested delivery does not exist.

delivery.update (string $incrementId, array|null $data = null, array|null $addItems = null, array|null $removeItems = null)

Update delivery attributes. Add products. Remove products.

Parameters

orderdescription
0 string - Increment ID.
1 object - Delivery data. See Delivery Properties.
2
  • null - Update delivery without adding items.
  • array - Array of objects with two properties: "sku" and "qty".
3
  • null - Update delivery without removing items.
  • array - Array of objects with two properties: "sku" and "qty".

Return Value

true if delivery was successfully updated.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.update",
        [
            "10000011",
            {
                "merchant_ref" : "Inv 12345",
                "merchant_status": "new",
                "sender_name" : "Bill Gates",
                "sender_ref": "100000004",
                "sender_ref_alt": "100000001",
                "expected_delivery" : "2014-07-31",
                "carrier_name": "FedEx",
                "auto_commit": 1,
                "comments": "This delivery was updated via API"                
            },
            [
                {
                    "sku": "O-VS-Oregano-p3",
                    "qty": "6.000"
                }
            ],
            [
                {
                    "sku": "O-VS-Oregano-p3",
                    "qty": "3.000"
                }
            ]
        ]
    ]
}

Example Response

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

delivery.commit (string $incrementId)

Commit delivery inventory.

Parameters

orderdescription
0 string - the "Increment ID" property.

Return Value

true if delivery inventory was successfully committed.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.commit",
        [
            "11000011"
        ]
    ]
}

Example Response

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

Error Codes

code message
113 Delivery with the specified ID cannot be committed. Details in the error message.

delivery.cancel (string $incrementId)

Cancel delivery.

Parameters

orderdescription
0 string - the "Increment ID" property.

Return Value

true if delivery was successfully canceled.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.cancel",
        [
            "11000017"
        ]
    ]
}

Example Response

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

Error Codes

code message
112 Delivery with the specified ID cannot be canceled. Details in the error message.

delivery.void (string $incrementId)

Cancel delivery.

Parameters

orderdescription
0 string - the "Increment ID" property.

Return Value

true if delivery was successfully voided.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.void",
        [
            "11000018"
        ]
    ]
}

Example Response

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

Error Codes

code message
114 Delivery with the specified ID cannot be voided. Details in the error message.

Entity Properties

Delivery Properties

Property Translations: API to UI

API ASN RMA Cancellation Other Work Order Output
sender_name Supplier Customer Name Customer Name Sender Assembly Completed By
sender_ref Supplier Invoice Ref Carrier Tracking # Order # Sender Ref 1 Work Order #
sender_ref_alt Supplier Order Ref Merchant Order # Shipment # Sender Ref 2 Not Supported
tracking_numbers Tracking Numbers Tracking Numbers Not Supported Tracking Numbers Not Supported
merchant_ref Merchant Ref Merchant RMA # Order Ref # Merchant Ref Work Order Ref
merchant_status Merchant Status Merchant Status Merchant Status Merchant Status Merchant Status
expected_delivery Expected Delivery Date Authorization Date Cancellation Date Expected Delivery Date Assembly Completed Date
delivery_id
{ "delivery_id" : 5 }
The internal delivery ID.
warehouse_id
{ "warehouse_id" : 1 }
The internal warehouse ID.
increment_id
{ "increment_id" : 1000036 }
The "Increment ID" property.
delivery_type
{ "delivery_type" : "asn" }
The "Delivery Type" property. Allowed: "asn", "rma", "other".
state
{ "state" : "complete" }
The "State" property. Allowed: "new", "processing", "putting_away", "pending_commit", "complete", "canceled", "holded".
status
{ "status" : "putting_away" }
The "Status" property. Allowed: "new", "accepting", "accepted", "ready_to_process", "processing", "processing_exception", "processed", "putting_away", "put_away", "complete", "canceled", "void", "holded".
before_hold_state
{ "before_hold_state" : "complete" }
The "Before Hold State" property.
before_hold_status
{ "before_hold_status" : "complete" }
The "Before Hold Status" property.
progress
{ "progress" : 85 }
The "Progress" property. Number from 0 to 100.
total_skus
{ "total_skus" : 2 }
Total amount of SKUs.
sender_name
{ "sender_name" : "RSF" }
The "Sender Name" property.
carrier_name
{ "carrier_name" : "FedEx" }
The "Carrier Name" property.
expected_delivery
{ "expected_delivery" : "2014-07-21" }
The "Expected Delivery" property.
delivered_at
{ "delivered_at" : "2014-07-21T08:52:56+00:00" }
The "Delivered At" property.
ready_to_process_at
{ "ready_to_process_at" : "2014-07-21T08:52:56+00:00" }
The "Delivered At" property.
processed_at
{ "processed_at" : "2014-07-21T08:52:56+00:00" }
The "Processed At" property.
putaway_at
{ "putaway_at" : "2014-07-21T08:52:56+00:00" }
The "Put-Away At" property.
completed_at
{ "completed_at" : "2014-07-21T08:52:56+00:00" }
The "Completed At" property.
comments
{ "comments" : "This is test delivery." }
The "Comments" property.
merchant_ref
{ "merchant_ref" : 12345 }
The "Merchant Reference" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.
merchant_status
{ "merchant_status" : "complete" }
The "Merchant Status" property.
sender_ref
{ "sender_ref" : 12345 }
The "Sender Reference" property.
sender_ref_alt
{ "sender_ref_alt" : "abc" }
The "Sender Reference Alt" property.
tracking_numbers
{ "tracking_numbers" : ["abc", "def"] }
The "Tracking Numbers" property.
num_containers
{ "num_containers" : 2 }
Number of containers.
num_labels
{ "num_labels" : 1 }
Number of labels.
total_container_weight
{ "total_container_weight" : 15.75 }
The "Total Container Weight" property.
total_container_weight_unit
{ "total_container_weight_unit" : "lb" }
The unit of measure used for total_container_weight. See: Weight Units.
total_product_weight
{ "total_product_weight" : 13.5 }
The "Total Product Weight" property.
total_product_weight_unit
{ "total_product_weight_unit" : "lb" }
The unit of measure used for total_product_weight. See: Weight Units.
special_requirements
{ "special_requirements" : "Please ship ASAP." }
The "Special Requirements" property.
auto_commit
{ "auto_commit" : 1 }
Flag whether inventory can be commited automatically. 0 - Disabled, 1 - Enabled, 2 - Use default from config
created_at
{ "created_at" : "2014-06-26T13:47:47+00:00" }
The "Created At" property.
updated_at
{ "updated_at" : "2014-06-26T13:47:47+00:00" }
The "Updated At" property.
items Array of delivery items. See "Delivery Item Properties".
containers Array of containers. See "Container Properties".
exceptions Array of exceptions. See "Exception Properties".

Delivery Item Properties

delivery_item_id
{ "delivery_item_id" : 3 }
The internal delivery item ID.
delivery_id
{ "delivery_id" : 5 }
The internal delivery ID.
product_id
{ "product_id" : 4 }
The internal product ID.
qty
{ "qty" : 2 }
The quantity that was set when the delivery was created or edited.
qty_expected
{ "qty_expected" : 2 }
The quantity that is expected to be received in the future.
qty_received
{ "qty_received" : 1 }
The "Received" quantity.
qty_shortage
{ "qty_shortage" : 0 }
The "Shortage" quantity.
qty_overage
{ "qty_overage" : 0 }
The "Overage" quantity.
qty_processed
{ "qty_processed" : 3 }
The "Processed" quantity.
qty_putaway
{ "qty_putaway" : 1 }
The "Put-Away" quantity.
qty_committed
{ "qty_committed" : 1 }
The "Committed" quantity.
sku
{ "sku" : "product1" }
The "SKU" property.

Delivery Label Properties

label_id
{ "label_id" : 2 }
The internal delivery label ID.
delivery_id
{ "delivery_id" : 22 }
The internal delivery ID.
warehouse_id
{ "warehouse_id" : 1 }
The internal warehouse ID.
status
{ "status" : "valid" }
The "Status" property. Allowed: "valid", "void".
shipping_method
{ "shipping_method" : "ups_03" }
See the Shipping Methods document for a reference. Is not optional.
created_at
{ "created_at" : "2021-01-18T13:57:25+00:00" }
The "Created At" property in ISO 8601 format.
updated_at
{ "updated_at" : "2021-01-18T13:57:25+00:00" }
The "Updated At" property in ISO 8601 format.
packages Array of delivery label packages. See "Delivery Label Package Properties".
destination_address Destination Address. See "Delivery Label Address Properties".
origin_address Origination Address. See "Delivery Label Address Properties".

Delivery Label Package Properties

warehouse_id
{ "warehouse_id" : "1" }
The ID of the warehouse associated with the package.
label_id
{ "label_id" : 2 }
The internal delivery label ID.
carrier
{ "carrier" : "ups" }
Carrier code.
weight
{ "weight" : "16.900" }
The weight of the package.
weight_unit
{ "weight_unit : "lb" }
The unit of measure used for weight. See: Weight Units.
dimensions
{
    "dimensions" : {
        "length": "16.000",
        "width": "12.000",
        "height": "8.000"
    }
}
The length, width, and height of the package.
dimension_unit
{ "dimension_unit" : "in" }
The unit of measure used for length, width, and height in dimensions. See: Length Units.
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.
package_items
[
    {
        "delivery_item_id": 1,
        "sku": "product1",
        "quantity": "2.0000"
    }, {
        "delivery_item_id": 3,
        "sku": "product2",
        "quantity": "2.0000"
    }
]
An array of items contained in the package.
"delivery_item_id" is the unqiue identifier of the related delivery item.
"sku" is the package item's SKU.
"quantity" is the quantity of the item in the package.

Delivery Label 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, "po" - post office, "mil" - military, "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.

Container Properties

container_id
{ "container_id" : 1 }
The internal container ID.
delivery_id
{ "delivery_id" : 5 }
The internal delivery ID.
container_type_id
{ "container_type_id" : 1 }
The "Container Type ID" property.
damage_type
{ "damage_type" : "none" }
The "Damage Type" property. Allowed: "none", "noted", "unnoted".
weight_discrepancy
{ "weight_discrepancy" : "none" }
The "Weight Discrepancy" property. Allowed: "none", "shortage_noted", "shortage_unnoted", "overage", "unknown".
tare_weight
{ "tare_weight" : 1.75 }
The "Tare Weight" property.
tare_weight_unit
{ "tare_weight_unit" : "lb" }
The unit of measure used for tare_weight. See: Weight Units.
weight
{ "weight" : 3.5 }
The "Weight" property.
weight_unit
{ "weight_unit" : "lb" }
The unit of measure used for weight. See: Weight Units.
weighed_at
{ "weighed_at" : "2014-06-26T13:49:15+00:00" }
The "Weighed At" property.
weighed_by
{ "weighed_by" : 1 }
The "Weighed By" property.
contents Array of "content" objects. See "Container Content Properties".
notes
{ "notes" : "Note text." }
The "Notes" property.

Container Content Properties

delivery_item_id
{ "delivery_item_id" : 1 }
The internal delivery item ID.
qty_counted
{ "qty_counted" : 5 }
The "Quantity Counted" property.
qty_shortage
{ "qty_shortage" : 2 }
The "Quantity Shortage" property.

Exception Properties

delivery_exception_id
{ "delivery_exception_id" : 2 }
The internal delivery exception ID.
delivery_id
{ "delivery_id" : 3 }
The internal delivery ID.
delivery_item_id
{ "delivery_item_id" : 4 }
The internal delivery item ID.
container_id
{ "container_id" : 5 }
The internal container ID.
status
{ "status" : "pending" }
The "Status" property. Allowed: "new", "pending", "approved", "rejected", "void".
sign
{ "sign" : 1 }
The "Sign" property. Allowed: "-1" - shortage, "1" - overage.
reason
{ "reason" : "overage_counted" }
The "Reason" property. Allowed: "overage_counted", "overage_unexpected", "shortage_damaged", "shortage_missing".
comment
{ "comment" : "Comment text here." }
The "Comment" property.
qty
{ "qty" : 1 }
The "Quantity" property.