Skip to main content
PATCH
/
v1
/
shipments
/
{id}
Update Shipment
curl --request PATCH \
  --url https://api.wizcommerce.com/v1/shipments/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Shipment Name",
  "id": "123",
  "order_id": "123",
  "updated_at": "2021-01-01T00:00:00Z",
  "status": "active",
  "shipment_status": "shipped",
  "tracking_info": {
    "tracking_number": "<string>",
    "tracking_url": "<string>",
    "delivery_partner": "<string>"
  },
  "shipment_items": [
    {
      "product_id": "<string>",
      "quantity": 2
    }
  ],
  "remark": "Door to Door",
  "note": "Handle with care"
}
'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "123",
    "order_id": "123",
    "created_at": "2021-01-01T00:00:00Z",
    "status": "shipped",
    "tracking_info": {
      "tracking_number": "123",
      "tracking_url": "https://www.google.com",
      "delivery_partner": "Fedex"
    },
    "shipment_items": [
      {
        "id": "123",
        "sku_id": "123",
        "quantity": 10
      }
    ],
    "updated_at": "2021-01-01T00:00:00Z",
    "note": "Handle with care"
  }
}
The PATCH request is used to partially update an existing entity by the given id. This means:
  • Only the fields provided in the request body will be updated.
  • Fields not provided in the request body will remain unchanged.
  • The request is idempotent, meaning multiple identical PATCH requests will always result in the same final state.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Shipment ID

Body

application/json

Shipment

​
name
string
required
Maximum string length: 255
Example:

"Shipment Name"

​
id
string
Maximum string length: 255
Example:

"123"

​
order_id
string
Maximum string length: 255
Example:

"123"

​
updated_at
string
Example:

"2021-01-01T00:00:00Z"

​
status
enum<string>
default:active
Available options:
active,
inactive
Example:

"active"

​
shipment_status
enum<string>
Available options:
shipped,
created
Example:

"shipped"

​
tracking_info
object
​
shipment_items
object[]
​
remark
string
Maximum string length: 255
Example:

"Door to Door"

​
note
string
Example:

"Handle with care"

Response

Created

​
data
object