GET
/
v2
/
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": "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",
        "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"
    }
  ],
  "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

page
integer
Required range: x >= 1
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
sort
enum<string>
default:desc
Available options:
asc,
desc
page_size
integer
Required range: 1 <= x <= 100
created_before
string

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

order_status
enum<string>
default:draft
Available options:
draft,
confirmed,
cancelled
updated_after
string

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

source
string
default:openapi
updated_before
string

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

reference_ids
string[]

List of customer reference ids separated by comma

Response

OK

The response is of type object.