Skip to main content
PUT
/
v2
/
orders
/
{id}
Update order
curl --request PUT \
  --url https://api.wizcommerce.com/v2/orders/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "reference_id": "1234567890",
  "display_id": "1234567890",
  "customer_id": "12345678-90ab-cdef-1234-567890abcdef",
  "payment_term": "Payment Term",
  "shipping_method": "Shipping Method",
  "freight_term": "Freight Term",
  "amount": 100,
  "amount_paid": 100,
  "discount_value": 10,
  "tax_value": 10,
  "shipping_charge": 10,
  "shipment_date": "2025-01-01T00:00:00Z",
  "due_date": "2025-01-01T00:00:00Z",
  "payment_status": "PAID",
  "payment_method_id": "1234567890",
  "fulfillment_status": "PARTIALLY_DELIVERED",
  "created_at": "2025-01-01T00:00:00Z",
  "customer_note": "Customer Notes",
  "internal_note": "Internal Notes",
  "updated_at": "2025-01-01T00:00:00Z",
  "source": "high-point",
  "po_number": "<string>",
  "customer_consent": {
    "has_consent": true,
    "consent_file_id": "<string>"
  },
  "container_info": {
    "name": "Container Name",
    "key": "40ft_hig",
    "unit": "CFT",
    "volume": 100
  },
  "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",
    "reference_id": "REF_1234567890",
    "attributes": [
      {
        "name": "1234567890",
        "value": "red"
      }
    ]
  },
  "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",
    "reference_id": "REF_1234567890",
    "attributes": [
      {
        "name": "1234567890",
        "value": "red"
      }
    ]
  },
  "primary_contact": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+14155552671",
    "designation": "Sales Manager",
    "reference_id": "12345678-90ab-cdef-1234-567890abcdef",
    "attributes": [
      {
        "name": "1234567890",
        "value": "red"
      }
    ]
  },
  "line_items": [
    {
      "sku": "RUG14754",
      "quantity": 10,
      "shipped_quantity": 0,
      "invoiced_quantity": 0,
      "cancelled_quantity": 0,
      "picked_quantity": 0,
      "unit_price": 100,
      "discount": 0,
      "discount_type": "percentage",
      "is_adhoc": false,
      "note": "Extra packing material"
    }
  ],
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ],
  "additional_charges": [
    {
      "name": "<string>",
      "type": "tax",
      "amount": 123
    }
  ]
}'
{
  "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",
      "reference_id": "12345678-90ab-cdef-1234-567890abcdef"
    },
    "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",
      "reference_id": "1234567890"
    },
    "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",
      "reference_id": "1234567890"
    },
    "po_number": "<string>",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  }
}
The PUT request is used to fully replace an existing entity with a new one based on the provided ID. This means:
  • All fields in the request body will overwrite the existing entity.
  • Any missing fields will be removed from the entity.
  • The request is idempotent, meaning multiple identical PUT 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

Body

application/json

request

​
customer_id
string
required
Example:

"12345678-90ab-cdef-1234-567890abcdef"

​
payment_status
enum<string>
required
Available options:
PAID,
PENDING,
PARTIALLY_PAID,
REFUNDED,
OVERPAID,
VOIDED
Example:

"PAID"

​
fulfillment_status
enum<string>
required
Available options:
PARTIALLY_DELIVERED,
UNFULFILLED,
PARTIALLY_FULFILLED,
FULFILLED,
IN_PROGRESS,
DELIVERED
Example:

"PARTIALLY_DELIVERED"

​
created_at
string
required
Example:

"2025-01-01T00:00:00Z"

​
updated_at
string
required

Updated at must be later than the order creation date

Example:

"2025-01-01T00:00:00Z"

​
line_items
object[]
required
​
reference_id
string
Maximum length: 255
Example:

"1234567890"

​
display_id
string

This is the display ID of the order, it is generated by the system if not provided.

Maximum length: 255
Example:

"1234567890"

​
payment_term
string
Maximum length: 255
Example:

"Payment Term"

​
shipping_method
string
Maximum length: 255
Example:

"Shipping Method"

​
freight_term
string
Maximum length: 255
Example:

"Freight Term"

​
amount
number

This is total amount of the order before all discounts, taxes, shipping charges, etc. are applied.

Example:

100

​
amount_paid
number
Example:

100

​
discount_value
number

Discount offered on the order, always amount of actual discount offered. e.g. if discount is 10% off, then discount value is 10.00 for 100.00 amount

Example:

10

​
tax_value
number

Tax value on the order, always amount of actual tax offered. e.g. if tax is 10% of amount, then tax value is 10.00 for 100.00 amount

Example:

10

​
shipping_charge
number

Shipping charge on the order, always amount of actual shipping charge offered. e.g. if shipping charge is $10.00, then shipping charge is $10.00

Example:

10

​
shipment_date
string

Shipment date must be later than the order creation date

Example:

"2025-01-01T00:00:00Z"

​
due_date
string

Due date must be later than the order creation date, send null if due date is not applicable

Example:

"2025-01-01T00:00:00Z"

​
payment_method_id
string
Maximum length: 255
Example:

"1234567890"

​
customer_note
string
Maximum length: 255
Example:

"Customer Notes"

​
internal_note
string
Maximum length: 255
Example:

"Internal Notes"

​
source
string

Source of the order, if not provided then it will be openapi

Example:

"high-point"

​
po_number
string
Maximum length: 255
​
customer_consent
object
​
container_info
object
​
billing_address
object

Billing address is stored and persisted in the order. It can be sent as custom address without ID which can be stored as temporary address to be used for billing only for this order. If ID provided, the address will be retrieved from the Address Service. This overrides any address fields in the request body

​
shipping_address
object

Shipping address is stored and persisted in the order. It can be sent as custom address without ID which can be stored as temporary address to be used for shipping only for this order. If ID provided, the address will be retrieved from the Address Service. This overrides any address fields in the request body

​
primary_contact
object

Primary contact is stored and persisted in the order. It can be sent as custom contact without ID which can be stored as temporary contact to be used for primary contact only for this order. If ID provided, the contact will be retrieved from the Contact Service. This overrides any contact fields in the request body

​
attributes
object[]
​
additional_charges
object[]

These are additional charges on the order apart from shipping, tax, discount, etc. It will be add-on to the total amount of the order.

Response

Created

​
data
object