List orders

curl --request GET \
  --url https://api.wizcommerce.com/v2/orders \
  --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": "[email protected]",
        "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": "[email protected]",
        "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": "[email protected]",
        "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"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

GET

orders

List orders

curl --request GET \
  --url https://api.wizcommerce.com/v2/orders \
  --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": "[email protected]",
        "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": "[email protected]",
        "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": "[email protected]",
        "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"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

Authorizations

X-API-Key

string

header

required

API Key for authentication

Query Parameters

created_after

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

sort_by

enum<string>

default:updated_at

Available options:

created_at,

updated_at

page

integer

Required range: x >= 1

page_size

integer

Required range: 1 <= x <= 100

created_before

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

sort

enum<string>

default:desc

Available options:

asc,

desc

updated_after

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

order_status

enum<string>

default:draft

Available options:

draft,

confirmed,

cancelled

updated_before

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

source

string

default:openapi

reference_ids

string[]

List of customer reference ids separated by comma

Response

data

object[]

Show child attributes

data.id

string

Example:

"01f5d171-d3e3-4b2b-bd57-0727194b5bed"

data.reference_id

string

Example:

"1234567890"

data.display_id

string

Example:

"WC_1234567890"

data.customer_id

string

Example:

"1234567890"

data.status

string

Example:

"active"

data.amount

number

Example:

100

data.amount_paid

number

Example:

100

data.payment_status

string

Example:

"PAID"

data.fulfillment_status

string

Example:

"PARTIALLY_DELIVERED UNFULFILLED PARTIALLY_FULFILLED FULFILLED IN_PROGRESS DELIVERED"

data.payment_method_id

string

Example:

"1234567890"

data.payment_method

string

Example:

"payment_method"

data.payment_term

string

Example:

"payment_term"

data.shipping_method

string

Example:

"shipping_method"

data.freight_term

string

Example:

"freight_term"

data.internal_note

string

Example:

"internal_note"

data.customer_note

string

Example:

"customer_note"

data.shipment_date

string

Example:

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

data.due_date

string

Example:

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

data.source

string

Example:

"cart"

data.price_list_id

string

Example:

"1234567890"

data.primary_contact

object

Show child attributes

data.primary_contact.id

string

Example:

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

data.primary_contact.first_name

string

Example:

"John"

data.primary_contact.last_name

string

Example:

"Doe"

data.primary_contact.email

string

Example:

"[email protected]"

data.primary_contact.phone

string

Example:

"+14155552671"

data.primary_contact.designation

string

Example:

"Sales Manager"

data.primary_contact.reference_id

string

Example:

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

data.shipping_address

object

Show child attributes

data.shipping_address.id

string

Example:

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

data.shipping_address.first_name

string

Example:

"John"

data.shipping_address.last_name

string

Example:

"Doe"

data.shipping_address.phone

string

Example:

"+14155552671"

data.shipping_address.email

string

Example:

"[email protected]"

data.shipping_address.address_line_1

string

Example:

"123 Main St"

data.shipping_address.address_line_2

string

Example:

"Apt 101"

data.shipping_address.city

string

Example:

"Anytown"

data.shipping_address.state

string

Example:

"CA"

data.shipping_address.country

string

Example:

"US"

data.shipping_address.zip_code

string

Example:

"12345"

data.shipping_address.reference_id

string

Example:

"1234567890"

data.billing_address

object

Show child attributes

data.billing_address.id

string

Example:

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

data.billing_address.first_name

string

Example:

"John"

data.billing_address.last_name

string

Example:

"Doe"

data.billing_address.phone

string

Example:

"+14155552671"

data.billing_address.email

string

Example:

"[email protected]"

data.billing_address.address_line_1

string

Example:

"123 Main St"

data.billing_address.address_line_2

string

Example:

"Apt 101"

data.billing_address.city

string

Example:

"Anytown"

data.billing_address.state

string

Example:

"CA"

data.billing_address.country

string

Example:

"US"

data.billing_address.zip_code

string

Example:

"12345"

data.billing_address.reference_id

string

Example:

"1234567890"

data.po_number

string

data.created_at

string

Example:

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

data.updated_at

string

Example:

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

pagination

object

Show child attributes

pagination.total_records

integer

Example:

100

pagination.total_pages

integer

Example:

10

pagination.current_page

integer

Example:

1

pagination.next_page

integer

Example:

2

pagination.prev_page

integer

Example:

0

pagination.page_size

integer

Example:

10

Revoke API Token Create order

⌘I

Auth

Core APIs

Authorizations

Query Parameters

Response