Reference: Shipment API

A shipment represents the delivery of items to the end customer.

The Shipment object

A Shipment is associated with:

• A single Purchase Order
• A single Shipper (carrier)
• One or more Order Items
• One or more Shipment Trackings (packages with distinct tracking numbers)

Each Shipment has the following attributes:

Retrieve a list of shipments

GET https://app.duoplane.com/shipments.json

All request parameters must be nested in a hash / associative array with the key "search". E.g.:

?search[retailer_id]=1

* Times should be in ISO 8601 format with time zone or zone offset. If not explicitly provided, the time zone is assumed to be that of the requesting API user.

Pagination

In addition to the search filters, you can specify paging parameters:

Option flag

In addition to the search filters, you can specify this option flag:

Create a new shipment

POST https://app.duoplane.com/purchase_orders/#{purchase_order_id}/shipments.json

To mark Order Items as fulfilled, create a Shipment and associate Order Items to that Shipment as Shipment Items.

Each Shipment must contain at least one Shipment Item and at least one tracking number (Shipment Tracking).

Sample request:

Note that only one of the following should be included to specify the carrier: shipper_id, shipper_name, or shipper_scac_code

POST https://app.duoplane.com/purchase_orders/987654/shipments.json
{
    "shipment": {
    	"shipper_name": "UPS",
	"vendor_shipping_cost": "",
	"vendor_handling_cost": "",
	"vendor_invoice_reference": "AB1234",
	"shipper_shipping_cost": 5.0,
    	"shipment_items_attributes": [
    		{
    			"order_item_id": 239417,
    			"quantity": 1
    		},
    		{
    			"order_item_id": 239418,
    			"quantity": 2
    		}
    	],
    	"shipment_trackings_attributes": [
    		{
    			"tracking": "1234"
    		},
    		{
    			"tracking": "5678"
    		}
    	]
        
    }
}

Update an existing shipment

PUT https://app.duoplane.com/shipments/#{shipment_id}.json

Sample request: Note that some shipment attributes fields might be readonly if the shipment data has already synced to either the ecommerce platform or to an external accounting system.

PUT https://app.duoplane.com/shipments/987654.json
{
    "shipment": {
	"vendor_shipping_cost": "3.5",
	"vendor_invoice_reference": "AB1234",
    }
}

Carrier options

Common options for the Shipper (carrier) are: