How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Orders API

An Order is created through the [checkout](/docs/api/carts/checkout) endpoint within the Carts API.An order is created after a customer checks out their cart. On creation, the order is marked unpaid. The customer is prompted for a shipping address, a billing address, and a payment method. After the order is successfully paid, you can trigger an inventory process and a shipping process.You can keep a history of orders associated with the customer account.### ReorderA re-order is when a shopper copies items from a previous order from their order history into a cart of their choice. If a shopper re-orders to an empty cart, the same quantities as the past order are applied. If the shopper re-orders to an existing cart, and orders the same item, the quantity increases. If an item is out of stock, the item is not added to the cart, and the shopper sees an insufficient stock error. The tax for the items in a re-order is not applied. For more information, see [Tax Items](/docs/api/carts/tax-items).

Elastic Path Orders API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 26.0313.7324347.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

6 operations 5 paths 44 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.0313.7324347
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 6

An Order is created through the [checkout](/docs/api/carts/checkout) endpoint within the Carts API. An order is created after a customer checks out their cart. On creation, the or…

GET
/v2/orders
Get all Orders
getCustomerOrders 5 params → 200
GET
/v2/orders/{orderID}
Get an Order
getAnOrder 2 params → 200404
PUT
/v2/orders/{orderID}
Update an Order
updateAnOrder 1 param body → 200400422
GET
/v2/orders/{orderID}/items
Get Order Items
getOrderItems 2 params → 200
POST
/v2/orders/anonymize
Anonymize Orders
anonymizeOrders body → 200422
POST
/v2/orders/{orderID}/confirm
Confirm Order
confirmOrder 1 param → 200400404422

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are OrderItemResponse (23 properties), TransactionResponse (20 properties), OrderResponse (17 properties), AddressCommon (10 properties). Each schema is shown below with its type and property counts.

OrderPriceData
object
3 properties
Response.Meta.Orders
object
2 properties
AddressCommon
object
10 properties 5 required
Response.PageLinks
object
5 properties
RelationshipItem
object
Relationship data entry
2 properties 2 required
Response.PaginationResults
object
1 property
RelationshipArray
object
Array of relationships
1 property
OrdersListResponse
object
1 property 1 required
OrderEntityResponse
object
3 properties
CustomAttributes
object
Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute valu…
Response.PaginationPage
object
4 properties
TransactionEntityResponse
object
1 property 1 required
OrderResponse
object
17 properties
OrderMeta
object
3 properties
OrdersUpdateRequest
object
1 property
OrderItemResponse
object
23 properties
OrdersCancelData
object
3 properties 2 required
OrdersAddressData
object
4 properties 2 required
OrderCollectionResponse
object
3 properties
OrderItemCollectionResponse
object
2 properties
OrdersAnonymizeRequest
object
1 property
Response.ErrorItem
object
5 properties 2 required
CondensedPromotionResponse
object
9 properties
Response.ErrorResponse
object
1 property 1 required
Contact
object
2 properties
OrderTimestamps
object
3 properties
AddressWithCounty
SingleRelationship
object
Single relationship
1 property
AddressWithRegion
NonNegativeFormattedPriceData
object
3 properties
OrdersAnonymizeData
object
1 property
TaxItemResponse
object
7 properties
DiscountData
object
6 properties
Timestamps
object
2 properties
DiscountFormattedPriceData
object
3 properties
BillingAddress
Billing address information. You must specify at least one of region (state/province) or county.
ShippingAddress
Shipping address information. You must specify at least one of region (state/province) or county.
FailureDetails
object
Non-PII payment failure information from the payment gateway. Only present on failed transactions where the gateway provided structured failure details.
2 properties
TransactionResponse
object
20 properties
OrdersFulfilledData
object
3 properties 2 required
OrderItemFormattedUnitPriceData
object
2 properties
Customer
object
3 properties
CustomDiscountResponse
object
8 properties
FormattedPriceData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-orders-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API
Where this information came from

This is an independent, third-party profile of Elastic Path Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.