Update Shipment

Replaces a shipment. This can be used to correct a tracking number, or to record a cost once the carrier has billed for it.

The complete shipment must be passed. Any fields left out will be updated as blank.

put

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Path parameters

order_idintegerRequired

Order Desk's internal order ID. This is not your source_id.

Example: 736745

shipment_idintegerRequired

Order Desk's internal ID for the shipment.

Example: 44821

Body

tracking_numberstringOptional

Carrier-assigned tracking number. Use n/a if no tracking number is applicable.

Example: 1Z999AA10123456784

carrier_codestringOptional

Carrier code such as USPS or FedEx, when available.

Example: UPS

shipment_methodstringOptional

Shipping service name, such as First Class International.

Example: UPS Ground

weightnumber · doubleOptional

Final shipment weight.

Example: 2.4

costnumber · doubleOptional

Your cost to send the shipment.

Example: 9.5

statusstringOptional

Current shipment status, used by the EasyPost webhook.

tracking_urlstringOptional

If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.

Responses

200

The shipment was updated.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

400

The request was rejected. message names the problem.

application/json

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

404

No record matches that ID in your store.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

put/orders/{order_id}/shipments/{shipment_id}

curl "https://app.orderdesk.me/api/v2/orders/736745/shipments/44821" \
  -X PUT \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"tracking_number": "1Z999AA10123456784", "carrier_code": "UPS", "shipment_method": "UPS 2nd Day Air", "weight": 2.4, "cost": 14.2}'

{
  "status": "success",
  "message": "Shipment Updated",
  "execution_time": "0.1524 seconds"
}