GET
/
vendor
/
orders
{
  "orders": [
    {
      "split_order_payment": {
        "id": "<string>",
        "status": "<string>",
        "authorized_amount": 123,
        "captured_amount": 123,
        "refunded_amount": 123,
        "currency_code": "<string>"
      },
      "fulfillments": [
        {
          "id": "<string>",
          "location_id": "<string>",
          "provider_id": "<string>",
          "shipping_option_id": "<string>",
          "provider": {
            "id": "<string>",
            "is_enabled": true
          },
          "delivery_address": {
            "id": "<string>",
            "company": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "address_1": "<string>",
            "address_2": "<string>",
            "city": "<string>",
            "country_code": "<string>",
            "province": "<string>",
            "postal_code": "<string>",
            "phone": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          },
          "items": [
            {
              "id": "<string>",
              "title": "<string>",
              "quantity": 123,
              "sku": "<string>",
              "barcode": "<string>",
              "line_item_id": "<string>",
              "inventory_item_id": "<string>",
              "fulfillment_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ],
          "labels": [
            {
              "id": "<string>",
              "tracking_number": "<string>",
              "tracking_url": "<string>",
              "label_url": "<string>",
              "fulfillment_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ],
          "packed_at": "<string>",
          "shipped_at": "<string>",
          "delivered_at": "<string>",
          "canceled_at": "<string>",
          "data": {},
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "shipping_address": {
        "id": "<string>",
        "customer_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "company": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "country_code": "us",
        "country": {
          "id": "<string>",
          "iso_2": "us",
          "iso_3": "usa",
          "num_code": 840,
          "name": "<string>",
          "display_name": "<string>"
        },
        "province": "<string>",
        "postal_code": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "billing_address": {
        "id": "<string>",
        "customer_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "company": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "country_code": "us",
        "country": {
          "id": "<string>",
          "iso_2": "us",
          "iso_3": "usa",
          "num_code": 840,
          "name": "<string>",
          "display_name": "<string>"
        },
        "province": "<string>",
        "postal_code": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "version": 123,
      "region_id": "<string>",
      "customer_id": "<string>",
      "sales_channel_id": "<string>",
      "email": "jsmith@example.com",
      "currency_code": "<string>",
      "display_id": 123,
      "items": [
        {
          "id": "<string>",
          "title": "<string>",
          "subtitle": "<string>",
          "thumbnail": "<string>",
          "variant": {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "title": "<string>",
            "sku": "<string>",
            "barcode": "<string>",
            "ean": "<string>",
            "upc": "<string>",
            "allow_backorder": true,
            "manage_inventory": true,
            "hs_code": "<string>",
            "origin_country": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "weight": 123,
            "length": 123,
            "height": 123,
            "width": 123,
            "options": [
              {
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "value": "<string>",
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "metadata": {
              "car": "white"
            }
          },
          "variant_id": "<string>",
          "product": {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "title": "<string>",
            "subtitle": "<string>",
            "description": "<string>",
            "handle": "<string>",
            "is_giftcard": true,
            "status": "draft",
            "thumbnail": "<string>",
            "width": 123,
            "weight": 123,
            "length": 123,
            "height": 123,
            "origin_country": "<string>",
            "hs_code": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "collection": {
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "title": "<string>",
              "handle": "<string>",
              "metadata": {
                "car": "white"
              }
            },
            "type": {
              "id": "<string>",
              "value": "<string>",
              "metadata": {
                "car": "white"
              }
            },
            "tags": [
              {
                "id": "<string>",
                "value": "<string>",
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "categories": [
              {
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "handle": "<string>",
                "is_active": true,
                "is_internal": true,
                "rank": 123,
                "parent_category": {},
                "category_children": [
                  {}
                ],
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "variants": [
              {
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "title": "<string>",
                "sku": "<string>",
                "barcode": "<string>",
                "ean": "<string>",
                "upc": "<string>",
                "allow_backorder": true,
                "manage_inventory": true,
                "hs_code": "<string>",
                "origin_country": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "weight": 123,
                "length": 123,
                "height": 123,
                "width": 123,
                "options": [
                  {
                    "id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "deleted_at": "2023-11-07T05:31:56Z",
                    "value": "<string>",
                    "metadata": {
                      "car": "white"
                    }
                  }
                ],
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "options": [
              {
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "title": "<string>",
                "values": [
                  {
                    "id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "deleted_at": "2023-11-07T05:31:56Z",
                    "value": "<string>",
                    "metadata": {
                      "car": "white"
                    }
                  }
                ],
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "images": [
              {
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "url": "<string>",
                "rank": 123,
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "discountable": true,
            "external_id": "<string>",
            "metadata": {
              "car": "white"
            },
            "rating": "<string>"
          },
          "product_id": "<string>",
          "product_title": "<string>",
          "product_description": "<string>",
          "product_subtitle": "<string>",
          "product_type": "<string>",
          "product_collection": "<string>",
          "product_handle": "<string>",
          "variant_sku": "<string>",
          "variant_barcode": "<string>",
          "variant_title": "<string>",
          "variant_option_values": {
            "Color": "Blue"
          },
          "requires_shipping": true,
          "is_discountable": true,
          "is_tax_inclusive": true,
          "compare_at_unit_price": 123,
          "unit_price": 123,
          "quantity": 123,
          "detail": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "metadata": {},
          "original_total": 123,
          "original_subtotal": 123,
          "original_tax_total": 123,
          "item_total": 123,
          "item_subtotal": 123,
          "item_tax_total": 123,
          "total": 123,
          "subtotal": 123,
          "tax_total": 123,
          "discount_total": 123,
          "discount_tax_total": 123,
          "refundable_total": 123,
          "refundable_total_per_unit": 123,
          "product_type_id": "<string>"
        }
      ],
      "shipping_methods": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "amount": 123,
          "is_tax_inclusive": true,
          "shipping_option_id": "<string>",
          "data": {},
          "metadata": {},
          "original_total": 123,
          "original_subtotal": 123,
          "original_tax_total": 123,
          "total": 123,
          "subtotal": 123,
          "tax_total": 123,
          "discount_total": 123,
          "discount_tax_total": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "commission_value": {
        "amount": 123,
        "currency_code": "<string>"
      },
      "commission_lines": [
        {
          "id": "<string>",
          "item_line_id": "<string>",
          "amount": 123,
          "currency_code": "<string>"
        }
      ],
      "payment_status": "canceled",
      "fulfillment_status": "canceled",
      "summary": {
        "total": 123,
        "subtotal": 123,
        "total_tax": 123,
        "ordered_total": 123,
        "fulfilled_total": 123,
        "returned_total": 123,
        "return_request_total": 123,
        "write_off_total": 123,
        "paid_total": 123,
        "refunded_total": 123
      },
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "original_item_total": 123,
      "original_item_subtotal": 123,
      "original_item_tax_total": 123,
      "item_total": 123,
      "item_subtotal": 123,
      "item_tax_total": 123,
      "original_total": 123,
      "original_subtotal": 123,
      "original_tax_total": 123,
      "total": 123,
      "subtotal": 123,
      "tax_total": 123,
      "discount_total": 123,
      "discount_tax_total": 123,
      "gift_card_total": 123,
      "gift_card_tax_total": 123,
      "shipping_total": 123,
      "shipping_subtotal": 123,
      "shipping_tax_total": 123,
      "original_shipping_total": 123,
      "original_shipping_subtotal": 123,
      "original_shipping_tax_total": 123
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
number

The number of items to skip before starting to collect the result set.

​
limit
number

The number of items to return.

​
fields
string

Comma-separated fields to include in the response.

​
order
string

The order of the returned items.

​
created_at
object

Filter by created at date range

​
status

Filter by order status

​
fulfillment_status
string

Filter by fulfillment status

​
payment_status
string

Filter by payment status

​
q
string

Search query for filtering orders

Response

200 - application/json

OK

The response is of type object.