PATCH
/
orders
/
{id}
/
status
Update order status
curl --request PATCH \
  --url https://api.wizcommerce.com/v1/orders/{id}/status \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "1234567890",
    "display_id": "WC_1234567890",
    "customer_id": "1234567890",
    "status": "active",
    "amount": 100,
    "amount_paid": 100,
    "payment_status": "PAID",
    "fulfillment_status": "PARTIALLY_DELIVERED UNFULFILLED PARTIALLY_FULFILLED FULFILLED IN_PROGRESS DELIVERED",
    "payment_method_id": "1234567890",
    "payment_method": "payment_method",
    "payment_term": "payment_term",
    "shipping_method": "shipping_method",
    "freight_term": "freight_term",
    "internal_note": "internal_note",
    "customer_note": "customer_note",
    "shipment_date": "2021-01-01T00:00:00Z",
    "due_date": "2021-01-01T00:00:00Z",
    "source": "cart",
    "price_list_id": "1234567890",
    "primary_contact": {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone": "+14155552671",
      "designation": "Sales Manager"
    },
    "shipping_address": {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+14155552671",
      "email": "john.doe@example.com",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "Anytown",
      "state": "CA",
      "country": "US",
      "zip_code": "12345"
    },
    "billing_address": {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+14155552671",
      "email": "john.doe@example.com",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "Anytown",
      "state": "CA",
      "country": "US",
      "zip_code": "12345"
    },
    "po_number": "<string>",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  }
}
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
status
enum<string>
required
Available options:
draft,
confirmed,
cancelled

Response

200
application/json

OK

The response is of type object.