List orders

GET

/api/subscriptions/orders

• Production server
• Development server

Authorizations

• bearer
• apiKey

Parameters

Query Parameters

status

string

Allowed values: PENDING PAID PARTIALLY_REFUNDED REFUNDED CANCELLED

fulfillment_status

string

Allowed values: UNFULFILLED PARTIALLY_FULFILLED FULFILLED

subscription_id

string

profile_id

string

entity_id

string

search

string

tracking_number

string

has_subscription

boolean

delivery_date_from

string

delivery_date_to

string

billing_date_from

string

billing_date_to

string

production_date_from

string

production_date_to

string

is_checkout_order

boolean

page

number

limit

number

sort_by

string

Allowed values: created_at delivery_date billing_date total status

sort_order

string

Allowed values: asc desc

Responses

200

object

data

required

Array<object>

object

id

required

string

status

required

string

Allowed values: PENDING PAID PARTIALLY_REFUNDED REFUNDED CANCELLED

created_at

string

nullable

updated_at

string

nullable

account_id

required

string

profile_id

string

nullable

shopify_order_id

required

string

production_date

string

nullable

currency_code

required

string

fulfillment_status

required

string

Allowed values: FULFILLED UNFULFILLED PARTIALLY_FULFILLED

shopify_order_number

string

nullable

external_order_id

string

nullable

external_order_number

string

nullable

external_source

string

nullable

order_type

required

string

Allowed values: SUBSCRIPTION ONE_TIME UPSELL

is_checkout_order

required

boolean

tracking_number

string

nullable

tracking_company

string

nullable

tracking_url

string

nullable

subtotal

required

number

discount_amount

required

number

total

required

number

billing_date

string

nullable

delivery_date

string

nullable

order_created_at

string

nullable

profile

One of:

string

string

object

object

id

string

timezone

string

nullable

address1

string

nullable

address2

string

nullable

city

string

nullable

region

string

nullable

country

string

nullable

postal_code

string

nullable

created_at

string

nullable

updated_at

string

nullable

full_address

string

email_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

email

string

external_id

string

nullable

first_name

string

nullable

last_name

string

nullable

full_name

string

phone_number

string

nullable

sms_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

shopify_customer_id

string

nullable

subscriptions

One of:

string

string

Array<object>

Array<object>

object

delivery_slot

One of:

string

string

object

object

id

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

position

number

label

string

start_time

string

end_time

string

is_all_day

boolean

delivery_day_id

string

meta

required

object

total

Total number of items

number

per_page

Items per page

number

current_page

Current page number

number

last_page

Last page number

number

first_page

First page number

number

first_page_url

URL for first page

string

last_page_url

URL for last page

string

next_page_url

URL for next page

string

nullable

previous_page_url

URL for previous page

string

nullable