curl --request POST \
--url https://api.wizcommerce.com/v1/orders \
--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",
"customer_note": "Customer Notes",
"created_at": "2025-01-01T00:00:00Z",
"internal_note": "Internal Notes",
"updated_at": "2025-01-01T00:00:00Z",
"status": "draft",
"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"
},
"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"
},
"primary_contact": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14155552671",
"designation": "Sales Manager"
},
"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"
},
"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"
}
}
Create order
curl --request POST \
--url https://api.wizcommerce.com/v1/orders \
--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",
"customer_note": "Customer Notes",
"created_at": "2025-01-01T00:00:00Z",
"internal_note": "Internal Notes",
"updated_at": "2025-01-01T00:00:00Z",
"status": "draft",
"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"
},
"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"
},
"primary_contact": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14155552671",
"designation": "Sales Manager"
},
"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"
},
"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"
}
}
API Key for authentication
request
The body is of type object
.
Created
The response is of type object
.
Was this page helpful?