Get An Order

Get an Order

GET/v2/orders/{orderID}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get An Order action (under Carts).
Fill in the fields below, then reference the result from later steps as {{getAnOrder.response.data}}.

Request

Path parameters

orderIDstringrequired

The ID of the order.

Query parameters

includestring

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

Response

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

dataobject

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

includedobject

Optional included data such as order items, tax items, custom discounts, and promotions.

itemsarray<object>24 fields

Array of order items included in the response.

tax_itemsarray<object>7 fields

Array of tax items included in the response.

custom_discountsarray<object>8 fields

Array of custom discounts included in the response.

promotionsarray<object>9 fields

Array of promotions included in the response.

errorsarray<object>

Array of error objects, if any errors occurred.

titlestringrequired

A brief summary of the error.

statusstring | integerrequired

The HTTP response code of the error.

detailstring

Optional additional detail about the error.

sourcestring

The field or location that caused the validation error. For JSON schema validation errors, this contains the JSON path to the invalid field (e.g., 'data.name', 'request', 'data.items[0].quantity').

metaobject13 fields

Additional metadata associated with the error. May include arbitrary keys.

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
    }
  },
  "included": {
    "items": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "quantity": 0,
        "product_id": "00000000-0000-0000-0000-000000000000",
        "subscription_offering_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "sku": "string",
        "location": "string",
        "unit_price": {
          "amount": 0,
          "currency": "string",
          "includes_tax": false
        },
        "value": {
          "amount": 0,
          "currency": "string",
          "includes_tax": false
        },
        "discounts": [
          {
            "amount": {
              "amount": null,
              "currency": null,
              "includes_tax": null
            },
            "code": "string",
            "id": "00000000-0000-0000-0000-000000000000",
            "promotion_source": "string",
            "is_cart_discount": false,
            "ordinal": 0,
            "promotion_action_id": "string"
          }
        ],
        "links": {}
      }
    ],
    "tax_items": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "jurisdiction": "string",
        "code": "string",
        "name": "string",
        "rate": 0,
        "amount": 0
      }
    ],
    "custom_discounts": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "external_id": "string",
        "discount_engine": "string",
        "amount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "description": "string",
        "discount_code": "string",
        "relationships": {
          "item": {
            "data": {
              "id": null,
              "type": null
            }
          }
        }
      }
    ],
    "promotions": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "description": "string",
        "automatic": false,
        "promotion_type": "string",
        "promotion_source": "string",
        "start": "2025-01-01T00:00:00Z",
        "end": "2025-01-01T00:00:00Z"
      }
    ]
  },
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string",
      "source": "string",
      "meta": {
        "id": "string",
        "ids": [
          "string"
        ],
        "item_ids": [
          "string"
        ],
        "shipping_group_id": "string",
        "shipping_group_ids": [
          "string"
        ],
        "cart_id": "string",
        "code": "string",
        "order_id": "string",
        "sku": "string",
        "email": "name@example.com",
        "component_product_id": "00000000-0000-0000-0000-000000000000",
        "error-meta-key": "string"
      }
    }
  ]
}

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

Was this page helpful?