Skip to main content
GET
Get past orders

Headers

X-API-Key
string

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

contractId
integer<int64>

Subscription contract ID. Omit (along with customerId) to get past orders of all contracts in the shop

customerId
integer<int64>

Shopify customer ID. Omit (along with contractId) to get past orders of all contracts in the shop

pageable
object
required

Pagination parameters (page number and size)

Response

Successfully retrieved past orders

retryingNeeded
boolean
required
shop
string
required
applyUsageCharge
boolean
attemptCount
integer<int32>
attemptTime
string<date-time>
billingAttemptId
string
billingAttemptResponseMessage
string
billingDate
string<date-time>
contractId
integer<int64>
graphOrderId
string
id
integer<int64>
inventorySkippedAttemptCount
integer<int32>
inventorySkippedRetryingNeeded
boolean
lastShippingUpdatedAt
string<date-time>
orderAmount
number<double>
orderAmountContractCurrency
number<double>
orderAmountShopCurrency
number<double>
orderAmountUSD
number<double>
orderAttributes
object[]
orderCancelReason
enum<string>
Available options:
CUSTOMER,
DECLINED,
FRAUD,
INVENTORY,
STAFF,
OTHER,
$UNKNOWN
orderCancelledAt
string<date-time>
orderClosed
boolean
orderClosedAt
string<date-time>
orderConfirmed
boolean
orderDisplayFinancialStatus
enum<string>
Available options:
PENDING,
AUTHORIZED,
PARTIALLY_PAID,
PARTIALLY_REFUNDED,
VOIDED,
PAID,
REFUNDED,
EXPIRED,
$UNKNOWN
orderDisplayFulfillmentStatus
enum<string>
Available options:
UNFULFILLED,
PARTIALLY_FULFILLED,
FULFILLED,
RESTOCKED,
PENDING_FULFILLMENT,
OPEN,
IN_PROGRESS,
ON_HOLD,
SCHEDULED,
REQUEST_DECLINED,
$UNKNOWN
orderId
integer<int64>
orderName
string
orderNote
string
orderProcessedAt
string<date-time>
partialLinesSkipped
enum<string>
Available options:
INVENTORY_MANAGEMENT,
MANUAL,
ORPHANED_FREE_PRODUCT
progressAttemptCount
integer<int32>
recurringChargeId
integer<int64>
securityChallengeSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CONTRACT_CANCELLED
status
enum<string>
Available options:
SUCCESS,
FAILURE,
REQUESTING,
PROGRESS,
QUEUED,
SKIPPED,
SOCIAL_CONNECTION_NULL,
CONTRACT_CANCELLED,
CONTRACT_ENDED,
CONTRACT_PAUSED,
AUTO_CHARGE_DISABLED,
SHOPIFY_EXCEPTION,
SKIPPED_DUNNING_MGMT,
SKIPPED_INVENTORY_MGMT,
IMMEDIATE_TRIGGERED,
SECURITY_CHALLENGE,
CONTRACT_PAUSED_MAX_CYCLES,
REFUNDED,
SKIPPED_DEMO_SHOP,
SKIPPED_SHOP_INFO_NOT_FOUND,
SKIPPED_BILLING_DATE_STALE,
SKIPPED_DUNNING_NOT_CONFIGURED,
PENDING_CONSOLIDATION
transactionFailedEmailSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_CANCELLED
transactionFailedSmsSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
SMS_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_CANCELLED,
PHONE_NUMBER_EMPTY
transactionRate
number<double>
upcomingOrderEmailSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_CANCELLED,
STOP_FROM_CONTRACT,
CONTRACT_PAUSED
upcomingOrderSmsSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
SMS_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_CANCELLED,
STOP_FROM_CONTRACT,
CONTRACT_PAUSED,
PHONE_NUMBER_EMPTY
usageChargeStatus
enum<string>
Available options:
SUCCESS,
FAILED,
TO_BE_TRIED
variantList
object[]