Orders

Get orders

get

Retrieves all orders for the specified store.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve orders for.

Example: 411486491630370816
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

order_idstring · flake-idOptional

Order ID

Example: 411486491630370816
customer_idstring · flake-idOptional

Customer ID

Example: 411486491630370816
billing_emailstringOptional

Billing Email

customer_ipstringOptional

Customer IP

subscription_idstring · flake-idOptional

Subscription ID

Example: 411486491630370816
checkout_idstring · flake-idOptional

Checkout ID

Example: 411486491630370816
is_subscriptionbooleanOptional

Flag indicating if the order is a subscription

affiliate_idstring · flake-idOptional

Affiliate ID

Example: 411486491630370816
coupon_idstring · flake-idOptional

Coupon ID

Example: 411486491630370816
giftcard_idstring · flake-idOptional

Gift card ID

Example: 411486491630370816
product_idstring · flake-idOptional

Product ID

Example: 411486491630370816
sale_idstring · flake-idOptional

Sale ID

Example: 411486491630370816
Responses
chevron-right
200

OK

application/json

Represents a customer order

idstring · flake-idRequiredExample: 411486491630370816
pretty_idstringRequired

The PayNow order ID identifier starting with pn-.

Example: pn-355eevennsow
store_idstring · flake-idRequiredExample: 411486491630370816
customer_idstring · flake-idRequiredExample: 411486491630370816
typestring · enumRequired

Defines the type of items contained in an order

Possible values:
statusstring · enumRequiredPossible values:
checkout_idstring · flake-idOptionalExample: 411486491630370816
checkout_tokenstring · nullableOptional

The checkout token for this order

Example: c4qqilpphugeqf2gndnkk5ad8fdq
subscription_idstring · flake-idOptionalExample: 411486491630370816
is_subscriptionbooleanRead-onlyRequired

Signifies if the order is a subscription order

coupon_idstring · flake-idOptionalExample: 411486491630370816
giftcard_idstring · flake-idOptionalExample: 411486491630370816
affiliate_idstring · flake-idOptionalExample: 411486491630370816
billing_namestringRequired

The billing name for this order

Example: John Doe
billing_emailstringRequired

The billing email for this order

Example: [email protected]
billing_countrystringRequired

The billing country for this order

Example: US
billing_cycle_sequenceinteger · int32Required

The billing cycle sequence (current renewal count) if this is a subscription order

customer_ipstringRequired

The IP address (IPv4 or IPv6) of the customer at time of order

Example: 192.168.1.1
currencystringRequired

The currency code used for this order

Example: usd
discount_amountinteger · int32Required

The total discount amount applied to this order in smallest currency unit

Example: 500
discount_amount_strstringRequired

The discount amount formatted as a string

Example: $5.00
subtotal_amountinteger · int32Required

The subtotal amount for this order in smallest currency unit

Example: 9995
subtotal_amount_strstringRequired

The subtotal amount formatted as a string

Example: $99.95
tax_amountinteger · int32Required

The tax amount for this order in smallest currency unit

Example: 999
tax_amount_strstringRequired

The tax amount formatted as a string

Example: $9.99
total_amountinteger · int32Required

The total amount for this order in smallest currency unit

Example: 10494
total_amount_strstringRequired

The total amount formatted as a string

Example: $104.94
giftcard_usage_amountinteger · int32Required

The amount of gift card value used for this order in smallest currency unit

Example: 0
giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

Example: $0.00
presentment_currencystringRequired

The presentment currency code used for this order (currency shown to customer)

Example: eur
presentment_subtotal_amountinteger · int32Required

The presentment subtotal amount in smallest currency unit

Example: 9995
presentment_subtotal_amount_strstringRead-onlyRequired

The presentment subtotal amount formatted as a string

Example: €99.95
presentment_discount_amountinteger · int32Required

The presentment discount amount in smallest currency unit

Example: 500
presentment_discount_amount_strstringRead-onlyRequired

The presentment discount amount formatted as a string

Example: €5.00
presentment_giftcard_usage_amountinteger · int32Required

The presentment gift card usage amount in smallest currency unit

Example: 0
presentment_giftcard_usage_amount_strstringRead-onlyRequired

The presentment gift card usage amount formatted as a string

Example: €0.00
presentment_tax_amountinteger · int32Required

The presentment tax amount in smallest currency unit

Example: 999
presentment_tax_amount_strstringRead-onlyRequired

The presentment tax amount formatted as a string

Example: €9.99
presentment_total_amountinteger · int32Required

The presentment total amount in smallest currency unit

Example: 10494
presentment_total_amount_strstringRead-onlyRequired

The presentment total amount formatted as a string

Example: €104.94
created_atstring · nullableOptional

The date and time when this order was created

Example: 2025-04-01T15:30:45Z
completed_atstring · nullableOptional

The date and time when this order was completed, if applicable

Example: 2025-04-01T15:35:22Z
get
/v1/stores/{storeId}/orders

Get order by ID

get

Retrieves an order by the ID for the specified store.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve the order for.

Example: 411486491630370816
orderIdstring · flake-idRequired

The ID of the order.

Example: 411486491630370816
Responses
chevron-right
200

OK

application/json

Represents a customer order

idstring · flake-idRequiredExample: 411486491630370816
pretty_idstringRequired

The PayNow order ID identifier starting with pn-.

Example: pn-355eevennsow
store_idstring · flake-idRequiredExample: 411486491630370816
customer_idstring · flake-idRequiredExample: 411486491630370816
typestring · enumRequired

Defines the type of items contained in an order

Possible values:
statusstring · enumRequiredPossible values:
checkout_idstring · flake-idOptionalExample: 411486491630370816
checkout_tokenstring · nullableOptional

The checkout token for this order

Example: c4qqilpphugeqf2gndnkk5ad8fdq
subscription_idstring · flake-idOptionalExample: 411486491630370816
is_subscriptionbooleanRead-onlyRequired

Signifies if the order is a subscription order

coupon_idstring · flake-idOptionalExample: 411486491630370816
giftcard_idstring · flake-idOptionalExample: 411486491630370816
affiliate_idstring · flake-idOptionalExample: 411486491630370816
billing_namestringRequired

The billing name for this order

Example: John Doe
billing_emailstringRequired

The billing email for this order

Example: [email protected]
billing_countrystringRequired

The billing country for this order

Example: US
billing_cycle_sequenceinteger · int32Required

The billing cycle sequence (current renewal count) if this is a subscription order

customer_ipstringRequired

The IP address (IPv4 or IPv6) of the customer at time of order

Example: 192.168.1.1
currencystringRequired

The currency code used for this order

Example: usd
discount_amountinteger · int32Required

The total discount amount applied to this order in smallest currency unit

Example: 500
discount_amount_strstringRequired

The discount amount formatted as a string

Example: $5.00
subtotal_amountinteger · int32Required

The subtotal amount for this order in smallest currency unit

Example: 9995
subtotal_amount_strstringRequired

The subtotal amount formatted as a string

Example: $99.95
tax_amountinteger · int32Required

The tax amount for this order in smallest currency unit

Example: 999
tax_amount_strstringRequired

The tax amount formatted as a string

Example: $9.99
total_amountinteger · int32Required

The total amount for this order in smallest currency unit

Example: 10494
total_amount_strstringRequired

The total amount formatted as a string

Example: $104.94
giftcard_usage_amountinteger · int32Required

The amount of gift card value used for this order in smallest currency unit

Example: 0
giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

Example: $0.00
presentment_currencystringRequired

The presentment currency code used for this order (currency shown to customer)

Example: eur
presentment_subtotal_amountinteger · int32Required

The presentment subtotal amount in smallest currency unit

Example: 9995
presentment_subtotal_amount_strstringRead-onlyRequired

The presentment subtotal amount formatted as a string

Example: €99.95
presentment_discount_amountinteger · int32Required

The presentment discount amount in smallest currency unit

Example: 500
presentment_discount_amount_strstringRead-onlyRequired

The presentment discount amount formatted as a string

Example: €5.00
presentment_giftcard_usage_amountinteger · int32Required

The presentment gift card usage amount in smallest currency unit

Example: 0
presentment_giftcard_usage_amount_strstringRead-onlyRequired

The presentment gift card usage amount formatted as a string

Example: €0.00
presentment_tax_amountinteger · int32Required

The presentment tax amount in smallest currency unit

Example: 999
presentment_tax_amount_strstringRead-onlyRequired

The presentment tax amount formatted as a string

Example: €9.99
presentment_total_amountinteger · int32Required

The presentment total amount in smallest currency unit

Example: 10494
presentment_total_amount_strstringRead-onlyRequired

The presentment total amount formatted as a string

Example: €104.94
created_atstring · nullableOptional

The date and time when this order was created

Example: 2025-04-01T15:30:45Z
completed_atstring · nullableOptional

The date and time when this order was completed, if applicable

Example: 2025-04-01T15:35:22Z
get
/v1/stores/{storeId}/orders/{orderId}

Refund order by ID

post

Creates a refund for an order by the ID for the specified store.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to refund the order for.

Example: 411486491630370816
orderIdstring · flake-idRequired

The ID of the order.

Example: 411486491630370816
Body
order_line_idstring · flake-idOptionalExample: 411486491630370816
refund_from_connected_user_balanceboolean · nullableOptional

Determines if the refund should be taken from the connected user's balance. Only relevant for connected platforms.

Responses
chevron-right
200

OK

application/json
idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
payment_idstring · flake-idRequiredExample: 411486491630370816
customer_idstring · flake-idRequiredExample: 411486491630370816
order_line_idstring · flake-idOptionalExample: 411486491630370816
statusstring · enumRequired

Represents the current status of a refund in the system

Possible values:
failure_reasonstring · nullableOptional

Reason for failure if the refund has failed

currencystringRequired

Three-letter currency code of the refund

amountinteger · int64Required

Amount of the refund in smallest currency unit (e.g., cents)

amount_strstringRequired

String representation of the refund amount, formatted for display

gateway_fee_amountinteger · int64Required

Amount of payment processor fees in smallest currency unit

gateway_fee_amount_strstringRequired

String representation of gateway fee amount, formatted for display

tax_amountinteger · int64Required

Amount of tax being refunded in smallest currency unit

tax_amount_strstringRequired

String representation of tax amount, formatted for display

platform_fee_amountinteger · int64Required

Amount of platform fees in smallest currency unit

platform_fee_amount_strstringRequired

String representation of platform fee amount, formatted for display

store_net_amountinteger · int64Required

Net amount for the store after fees in smallest currency unit

store_net_amount_strstringRequired

String representation of store net amount, formatted for display

store_refund_amountinteger · int64Required

Amount of the refund to be paid by the store in smallest currency unit

store_refund_amount_strstringRequired

String representation of store refund amount, formatted for display

presentment_currencystring · nullableOptional

Optional currency code used for presentment to the customer if different from the base currency

presentment_amountinteger · nullableOptional

Optional amount in presentment currency in smallest currency unit

fx_ratestring · nullableOptional

Exchange rate used while refunding. Only present for payments made in non-settlement currency.

refund_from_connected_user_balancebooleanRequired

Indicates whether the refund should be taken from the connected user's balance. Only relevant for platforms.

created_atstring · date-timeRequired

Date and time when the refund was created

approved_atstring · nullableOptional

Optional date and time when the refund was approved

pending_atstring · nullableOptional

Optional date and time when the refund entered pending status

completed_atstring · nullableOptional

Optional date and time when the refund was completed

canceled_atstring · nullableOptional

Optional date and time when the refund was canceled

failed_atstring · nullableOptional

Optional date and time when the refund failed

post
/v1/stores/{storeId}/orders/{orderId}/refund

Last updated

Was this helpful?