GET
/
orders
/
{id}
Get order
curl --request GET \
  --url https://api.wizcommerce.com/v1/orders/{id} \
  --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,
    "shipment_date": "2021-01-01T00:00:00Z",
    "due_date": "2021-01-01T00:00:00Z",
    "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",
    "source": "cart",
    "price_list_id": "1234567890",
    "line_items": [
      {
        "product_id": "1234567890",
        "sku": "1234567890",
        "quantity": 10,
        "unit_price": 100,
        "shipped_quantity": 0,
        "invoiced_quantity": 0,
        "cancelled_quantity": 0,
        "picked_quantity": 0,
        "discount": 0,
        "discount_type": "percentage",
        "note": "Extra packing material",
        "is_adhoc": false
      }
    ],
    "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"
    },
    "charges": [
      {
        "name": "shipping",
        "type": "shipping",
        "value_type": "percentage",
        "amount": 100
      }
    ],
    "container_info": {
      "name": "Container Name",
      "key": "40ft_hig",
      "unit": "CFT",
      "volume": 100
    },
    "customer_consent": {
      "has_consent": true,
      "consent_file_id": "1234567890"
    },
    "attributes": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "name": "Color",
        "value": "Red",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "po_number": "<string>",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "card": {
      "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "token": "PIuTv1UgBqESZ2KRDixPtDJt",
      "payment_method_type": "card",
      "brand": "visa",
      "card_type": "debit",
      "last_four_digits": "1111",
      "card_exp": "09/25",
      "external_customer_id": "cus_1234567890"
    }
  }
}

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Response

200
application/json

OK

The response is of type object.