Order Object

{
  "source": "CHECKOUT",
  "mode": "LIVE",
  "id": "string",
  "external_id": "string",
  "status": "IN_PROGRESS",
  "email": "string",
  "invoice_number": "string",
  "items": [
    {
      "id": "string",
      "product_id": "string",
      "variation_id": "string",
      "external_product_id": "string",
      "external_variation_id": "string",
      "name": "string",
      "image": "string",
      "sku": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "quantity": 0,
      "shippable": true,
      "unit_price": 0,
      "unit_weight": 0,
      "unit_dimensions": {
        "height": 0,
        "width": 0,
        "length": 0
      },
      "total": 0,
      "combined_weight": 0,
      "metadata": "string"
    }
  ],
  "billing_address": {
    "first_name": "string",
    "last_name": "string",
    "full_name": "string",
    "address_1": "string",
    "address_2": "string",
    "street_number": "string",
    "street_name": "string",
    "city": "string",
    "sub_locality": "string",
    "region": "string",
    "country": "string",
    "postal_code": "string",
    "phone": "string"
  },
  "shipping_address": {
    "first_name": "string",
    "last_name": "string",
    "full_name": "string",
    "address_1": "string",
    "address_2": "string",
    "street_number": "string",
    "street_name": "string",
    "city": "string",
    "sub_locality": "string",
    "region": "string",
    "country": "string",
    "postal_code": "string",
    "phone": "string"
  },
  "shipping_method": {
    "name": "string",
    "cost": 0
  },
  "shipping_instructions": "string",
  "discounts": [
    {
      "id": "string",
      "savings": 0,
      "name": "string",
      "type": "string"
    }
  ],
  "taxes": [
    {
      "name": "string",
      "amount": 0,
      "rate": 0
    }
  ],
  "subtotal": 0,
  "total": 0,
  "payment": {
    "transaction_id": "string",
    "status": "PAID",
    "currency": "string",
    "card_brand": "NULL",
    "confirmed_method": {
      "gateway": "NONE",
      "name": "UNKNOWN",
      "display_name": "string",
      "icon": "string",
      "details": "string",
      "instructions": "string"
    }
  },
  "refunds": [
    {}
  ],
	"fulfillment_status": "FULFILLED",
	"fulfillments": [
		{
			"id": "fulfill_123",
			"status": "FULFILLED",
			"method": "SHIPMENT",
			"items": [
				{
					"id": "item_123",
					"quantity": 2
				},
				{
					"id": "item_456",
					"quantity": 1
				}
			],
			"tracking": {
				"number": "123456",
				"url": "https://example.com",
				"carrier": "USPS"
			},
			"created": "2025-05-01T14:52:29.729Z",
			"updated": "2025-05-01T14:52:29.729Z",
		}
	],
	"unfulfilled_items": [
		{
			"id": "item_123",
			"quantity": 4,
			"method": "SHIPMENT"
		},
		{
			"id": "item_456",
			"quantity": 1,
			"method": "EMAIL_MESSAGE"
		}
	],
  "tracking_url": "string",
  "tracking_number": "string",
  "created": "2023-08-02T14:52:29.729Z",
  "user_agent": "string",
  "ip_address": "string",
  "cancellation_reason": "string",
  "cancelled": "2024-12-11T18:28:17.853Z",
  "metadata": "string"
}

order_details

Property

Description

mode string

Can be "TEST" or "LIVE".

id string

Unique identifier of the order.

status string

Can be "IN_PROGRESS", "PROCESSED", "SHIPPED", "DELIVERED", "PENDING", "CANCELLED", or "DISPATCHED". Note: The DISPUTED is now deprecated. Any usage of it will set the status to "CANCELLED".

email string

Email associated with the order.

invoice_number string

Invoice number of the order.

items object[]

The items in the order.

billing_address object

The billing address details of the order owner.

shipping_address object

The shipping address details of the order owner.

shipping_method object

The shipping method of the order.

discounts object[]

The discounts applied to the order.

taxes object[]

The taxes applied to the order.

subtotal number

Cost of the order before any additions (i.e.: Taxes, Shipping, etc.)

total number

The total cost of the order.

payment object

The payment information of the order.

refunds object[]

The refunds applied to the order.

fulfillment_status string

The fulfillment status of the order.

fulfillments object[]

The fulfillments applied to the order.

unfulfilled_items object[]

Array of items impacted by the same fulfillment

tracking_url string

Public URL from the shipping provider to get updates on the shipped order.

tracking_number string

Public tracking number associated to the order.

created string

Date that indicates when the order was completed.

user_agent string

User agent of the customer who made the order.

ip_address string

IP address of the customer who made the order.

cancellation_reason string

Reason why the order was cancelled.

cancelled string

Date when the order was cancelled.

metadata string

Metadata associated with the order.

items

Property

Description

id string

System identifier of the line item.

product_id string

The unique identifier for the product backing this order item.

variation_id string

The unique identifier for the product variation backing this order item.

external_product_id string

The external id of the product backing this order item.

external_variation_id string

The external id of the product variation backing this order item.

name string

Display name of the line item.

image string

Display image of the line item.

options object[]

Options selected by the customer associated with the line item.

shippable bool

Indicates if this item requires shipping.

quantity number

Quantity bought for this item.

unit_price number

Price of a single unit of this line item.

unit_weight number

Weight of a single unit of this line item.

unit_dimensions object

Dimensions of this line item.

total number

Total price of this line item (quantity * unit price).

combined_weight number

Total weight of this line item (quantity * unit weight).

options

Property

Description

Mutable

name string

Name of the option.

Yes

value string

Value of the option.

Yes

unit_dimensions

Property

Description

height number

Height of a single unit of this line item.

width number

Width of a single unit of this line item.

length number

Length of a single unit of this line item.

address

Field

Description

first_name string

First Name attached to the address.

last_name string

Last Name attached to the address.

full_name string

Full Name attached to the address.

address_1 string

The first line of the address.

address_2 string

The second line of the address.

street_number

  • string

The street number note: this may be part of the address_1 or address_2 values, but is available here as a separate value.

street_name
string

The street name note: this may be part of the address_1 or address_2 values, but is available here as a separate value.

city
string

Name of city attached to the address.

sub_locality
string

Sub-locality attached to the address (ex: county or district name).

region
string

Region attached to the address (ex. the state or province name).

country
string

Country attached to the address.

postal_code
string

Postal code attached to the address.

phone
string

Phone number of contact located at this address.

shipping_method

Property

Description

name string

Name of the shipping method selected on the order.

cost number

The cost incurred for the order by the shipping method.

discounts

Property

Description

id string

System identifier of the discount resource that was added to this order.

savings number

The amount of money that was saved on the total of the order using the discount.

name string

The name of the discount.

type string

The type of discount that was applied to the order.

taxes

Property

Description

name string

Name of the tax.

amount number

Amount of the tax when applied to the given order.

rate number

Percentage rate of the amount that was added for this tax.

payment

Property

Description

transaction_id string

Unique identifier given by the payment provider used to identify the payment made for the order.

status string

Can be "PAID", "DEFERRED", "PAID_DEFERRED", "CHARGED_BACK", "REFUNDED", "PAIDOUT", "PENDING", "FAILED", "EXPIRED", "CANCELLED", "OPEN", or "AUTHORIZED".

currency string

Currency of the order.

card_brand string

Can be "NULL", "VISA", "MASTERCARD", "AMEX", "DINERS_CLUB", "DISCOVER", "J_C_B", "CARD_BLEUE", "DANKORT", "CARTA_SI", "POSTEPAY", "MAESTRO", "LASER", "UNIONPAY", or "OTHER".

confirmed_method object

The confirmed payment method for the order.

refunds

Property

Description

id string

System identifier of the refund.

amount number

Refunded amount.

reason string

Reason written by the merchant for the refund.

created string

Date of the refund.

fulfillments

Property

Description

id string

System identifier of a fulfillment, it will always start with the prefix fulfil_.

status string

Status of the fulfillment. Possible values are:

IN_PROGRESS: This status is used by the store pickup flow. If the fulfillment is in progress, it means that all items in the given fulfillment are ready for pickup.

FULFILLED: Used for all other flows that support fulfillment (shipment, digital goods). For the pickup flow, the FULFILLED status means that the items have been picked up by the customer.

method
string

Method used to process the fulfillment. Possible values are:

EMAIL_MESSAGE: Automatic fulfillment of digital goods via email.

SHIPMENT: All physical items that are marked as shippable in the product catalog and need to be shipped to the customer.

PICKUP: All physical items when the customer selects a pickup method at checkout.

items
object[]

Record of the order’s line item IDs and the quantity fulfilled by the specific fulfillment.

Note that it can only contain fulfillable items (e.g. paid memberships, bookings (in the future), are not fulfillable).

All items in a same fulfillment must be fulfillable by the same method. e.g. A fulfillment with digital goods, and physical items, can’t be in the same fulfillment.

tracking
object

This property can only be set when the fulfillment method
is SHIPMENT, and is optional. For other methods, this will always be null.

Note that this can be updated after the fulfillment is created.

created
string

Timestamp of the creation of the fulfillment.

updated
string

Timestamp of the last update of the fulfillment.
(status update OR tracking update).

unfulfilled_items

Property

Description

id string

The unique identifier of the line item that needs to be fulfilled by the merchant.

quantity number

Quantity of the line item that still needs to be fulfilled.

method string

Method of fulfillment of the item.

confirmed_method

Property

Description

gateway string

Can be "NONE", "STRIPE", "SQUARE", "CUSTOM", "PAYPAL_COMMERCE_EXPRESS_CHECKOUT_ONLY", "PAYPAL_COMMERCE", "MANUAL_PAYMENTS", or "MOLLIE".

name string

Can be "UNKNOWN", "CREDIT_CARD", "PAYPAL", "MANUAL", "CUSTOM", "NO_PAYMENT", "APPLE_PAY", "GOOGLE_PAY", "MASTERPASS", "AMEX_EXPRESS_CHECKOUT", "SAMSUNG_PAY", "VISA_CHECKOUT", "LINK", "ACH_CREDIT_TRANSFER", "ACH_DIRECT_DEBIT", "ACSS_DEBIT", "ALIPAY", "BECS_DIRECT_DEBIT", "BANCONTACT", "POINT_OF_SALE", "EPS", "IDEAL", "KLARNA", "MULTIBANCO", "PRZELEWY24", "SEPA_DIRECT_DEBIT", "SOFORT", "WE_CHAT_PAY", "AFFIRM", "AFTERPAY_CLEARPAY", "BACS_DIRECT_DEBIT", "BLIK, BOLETO", "CASH", "FPX", "GRAB_PAY", "INTERAC_DEBIT", "KONBINI", "OXXO", "PAY_NOW", "PIX", "PROMPT_PAY", "TWINT", "CHECK", "BANK_TRANSFER", "GIFT_CARD", "CRYPTO", "SQUARE_CASH_APP", "VOUCHER", "CASH_APP", "PAY_PAY", "RAKUTEN_PAY", "AU_PAY", "D_BARAI, MERPAY", "AMAZON_PAY", "MOBILE_PAY", "REVOLUT_PAY", "SWISH", or "ZIP".

display_name string

The name of the payment method.

icon string

The icon associated with the payment method.

details string

The details of the payment method.

instructions string

The instructions for the payment method.

fulfillment_items

Property

Description

id string

The unique identifier of the line item.

quantity number

Quantity fulfilled of the line item.

tracking

Property

Description

number string

Reference number given by the shipping carrier. This will be customer facing in the emails, customer dashboard, etc.

url string

Absolute URL pointing to the carrier’s interface so customers and merchant can follow up on a shipment. This will be customer facing in the emails, customer dashboard, etc.

carrier string

Display name of the carrier used for the shipment. This will be customer facing in the emails, customer dashboard, etc.