Skip to main content
GuidesAPI Reference

List Orders

GET 
/commerce/orders

List orders for a specified connection

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber string

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    orderNumber string

    A string used to retrieve orders with a specific order number.

    orderNumberContains string

    A string used to retrieve orders with an order number containing a specific value.

    orderNumberNotEquals string

    A string that should not match the order number of orders to be retrieved.

    orderStatus string

    A string used to retrieve orders with a specific order status.

    orderStatusContains string

    A string used to retrieve orders with an order status containing a specific value.

    orderStatusNotEquals string

    A string that should not match the order status of orders to be retrieved.

    fulfillmentStatus string

    A string used to retrieve orders with a specific fulfillment status.

    fulfillmentStatusContains string

    A string used to retrieve orders with a fulfillment status containing a specific value.

    fulfillmentStatusNotEquals string

    A string that should not match the fulfillment status of orders to be retrieved.

    totalShipping float

    A specific value used to retrieve orders with a matching shipping total.

    totalShippingMin float

    The minimum allowed value for filtering orders based on their shipping total.

    totalShippingMax float

    The maximum allowed value for filtering orders based on their shipping total.

    totalShippingNotEquals float

    A value that should not match the shipping total of orders to be retrieved.

    totalDiscount float

    A specific value used to retrieve orders with a matching discount total.

    totalDiscountMin float

    The minimum allowed value for filtering orders based on their discount total.

    totalDiscountMax float

    The maximum allowed value for filtering orders based on their discount total.

    totalDiscountNotEquals float

    A value that should not match the discount total of orders to be retrieved.

    totalTax float

    A specific value used to retrieve orders with a matching tax total.

    totalTaxMin float

    The minimum allowed value for filtering orders based on their tax total.

    totalTaxMax float

    The maximum allowed value for filtering orders based on their tax total.

    totalTaxNotEquals float

    A value that should not match the tax total of orders to be retrieved.

    totalPrice float

    A specific value used to retrieve orders with a matching total price.

    totalPriceMin float

    The minimum allowed value for filtering orders based on their total price.

    totalPriceMax float

    The maximum allowed value for filtering orders based on their total price.

    totalPriceNotEquals float

    A value that should not match the total price of orders to be retrieved.

    currency string

    A string used to retrieve orders with a specific currency.

    currencyContains string

    A string used to retrieve orders with a currency containing a specific value.

    currencyNotEquals string

    A string that should not match the currency of orders to be retrieved.

    paymentStatus string

    A string used to retrieve orders with a specific payment status.

    paymentStatusContains string

    A string used to retrieve orders with a payment status containing a specific value.

    paymentStatusNotEquals string

    A string that should not match the payment status of orders to be retrieved.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    orders

    object[]

  • Array [

    • id string
    remoteId string
    orderStatus string

    lineItems

    object[]

  • Array [

    • quantity integer

    Default value: 0

    productId string
    price string
    unitCost string
    currency string
    variantId string
    title string
    sku string

  • ]

    • orderNumber string
    paymentStatus string

    customer

    object

    customerId string
    firstName string
    lastName string
    phone string
    email string
    currency string
    totalPrice string
    totalDiscount string
    totalShipping string
    totalTax string
    fulfillmentStatus string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...