younifyd
Menu

Get Customer Orders

Get all Orders

GET/v2/orders

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Customer Orders action (under Carts).
  3. Fill in the fields below, then reference the result from later steps as {{getCustomerOrders.response.data}}.

Request

Query parameters

includestring

Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).

page[limit]integer

The maximum number of records per page.

Default 20

page[offset]integer

The number of records to offset the results by.

Default 0

filterstring

Filter expression for searching orders. See filtering documentation for available operators and attributes.

Headers

x-moltin-customer-tokenstring

A customer token to access a specific customer's orders.

Response

Returns 200 with an object. Read it in later steps with {{getCustomerOrders.response.data.<field>}}.

dataarray<object>
typestring

Specifies the type of object being returned. You must use `order`.

order_numberstring

Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.

external_refstring

An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.

idstring (uuid)

Specifies the unique identifier of the order.

statusstring

Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.

One ofcompleteincompletecancelledprocessing

paymentstring

Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.

One ofauthorizedpaidunpaidrefundedpartially_paidpartially_authorized

shippingstring

Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.

One ofunfulfilledfulfilled

anonymizedboolean

Specifies if the order is anonymized.

payment_intent_idstring

Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.

custom_attributesobject

Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types. Example: ``` "custom_attributes": { "is_member": { "type": "boolean", "value": true }, "membership_level": { "type": "string", "value": "premium" } } ```

linksobject
metaobject3 fields
billing_addressoneOf

Billing address information. You must specify at least one of region (state/province) or county.

contactobject2 fields
customerobject3 fields
shipping_addressany

Shipping address information. You must specify at least one of region (state/province) or county.

relationshipsobject7 fields
linksobject
currentstring

Always the current page.

firststring

Always the first page.

laststring

If there is only one page, it is `null`.

nextstring

If there is only one page, it is `null`.

prevstring

if the user is on the first page, it is `null`.

metaobject
pageobject4 fields
resultsobject1 fields
json
{
  "data": [
    {
      "type": "string",
      "order_number": "string",
      "external_ref": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "complete",
      "payment": "authorized",
      "shipping": "unfulfilled",
      "anonymized": false,
      "payment_intent_id": "string",
      "custom_attributes": {},
      "links": {},
      "meta": {
        "timestamps": {
          "created_at": "string",
          "updated_at": "string",
          "fully_paid_at": "string"
        },
        "display_price": {
          "with_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "balance_owing": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "paid": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "authorized": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "shipping": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "shipping_discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          }
        },
        "is_manual": false
      }
    }
  ],
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "page": {
      "current": 0,
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "results": {
      "total": 0
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?