GET /v1/commerce/draft-orders

GET/v1/commerce/draft-orders

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsDraftOrder[] | nullrequired

Show properties

Array of DraftOrder

customer_phonestring

delivery_fee_amountinteger<int64>

discount_amountinteger<int64>required

idstringrequired

itemsDraftOrderItemRecord[] | null

Show properties

Array of DraftOrderItemRecord

compare_at_price_amountinteger<int64>

idstring

line_subtotal_amountinteger<int64>required

product_idstringrequired

product_snapshotobject

quantityinteger<int32>required

retailer_idstringrequired

selected_optionsobject

skustring

titlestringrequired

unit_price_amountinteger<int64>required

variant_idstring

total_amountinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/draft-orders"

const response = await fetch("/v1/commerce/draft-orders", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/draft-orders",
)

Response

{
  "items": [
    {
      "customer_phone": "string",
      "delivery_fee_amount": 0,
      "discount_amount": 0,
      "id": "string",
      "items": [
        {
          "compare_at_price_amount": 0,
          "id": "string",
          "line_subtotal_amount": 0,
          "product_id": "string",
          "product_snapshot": {},
          "quantity": 0,
          "retailer_id": "string",
          "selected_options": {},
          "sku": "string",
          "title": "string",
          "unit_price_amount": 0,
          "variant_id": "string"
        }
      ],
      "total_amount": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}