update_a_shipment's_status.markdown

Shipments API

Update a shipment's status

PUT /shipments/:id

Parameters

Name	Description	Required	Scope
tracking_number	String, shipment tracking number	false
shipment_status	String, shipment status	true

Request

Headers

Authorization: Bearer myaccesstoken

Route

PUT /shipments/%3Aid

Body

{"tracking_number":"93748896910904960011677211","shipment_status":"label_created"}

Response

Headers

Content-Type: application/json; charset=utf-8

Status

200 OK

Body

{
  "data": {
    "id": 66,
    "tracking_number": "93748896910904960011677211",
    "ship_date": null,
    "shipment_status": "label_created",
    "order_id": 47,
    "priority_processing": null,
    "label_url": null,
    "shipment_priority": "economy"
  },
  "errors": [

  ]
}