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

sitecore Orders API

Endpoints for creating, retrieving, updating, and deleting order records associated with guests. Orders capture purchase transactions including line items, payments, and fulfillment data.

sitecore Orders API is one of 33 APIs that Sitecore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

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

This API exposes 13 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://api-engage-eu.sitecorecloud.io, https://api-engage-us.sitecorecloud.io, https://api-engage-ap.sitecorecloud.io, https://api-engage-jpe.sitecorecloud.io, https://api.ordercloud.io/v1.

13 operations 6 paths 15 schemas 2 DELETE5 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://edge.sitecorecloud.io/api/graphql
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

sitecore Orders API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • basicAuth — HTTP Basic authentication using a client key as the username and an API token as the password. Credentials are obtained from Sitecore CDP Settings API access.
  • bearerAuth — OAuth 2.0 bearer token obtained from https://auth.ordercloud.io/oauth/token. The token scope determines accessible resources based on assigned roles.

Paths & Operations 13

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

Orders 13

Endpoints for creating, retrieving, updating, and deleting order records associated with guests. Orders capture purchase transactions including line items, payments, and fulfillme…

GET
/v2.1/guests/{guestRef}/orders
List guest orders
listGuestOrders 1 param → 200401404
POST
/v2.1/guests/{guestRef}/orders
Create an order
createOrder 1 param body → 201400401404
GET
/v2.1/guests/{guestRef}/orders/{orderRef}
Get an order
getOrder 2 params → 200401404
PUT
/v2.1/guests/{guestRef}/orders/{orderRef}
Update an order
updateOrder 2 params body → 200400401404
DELETE
/v2.1/guests/{guestRef}/orders/{orderRef}
Delete an order
deleteOrder 2 params → 204401404
GET
/orders/{direction}
List orders
listOrders 6 params → 200401
POST
/orders/{direction}
Create an order
createOrder 1 param body → 201400401
GET
/orders/{direction}/{orderID}
Get an order
getOrder 2 params → 200401404
PUT
/orders/{direction}/{orderID}
Update an order
updateOrder 2 params body → 200400401404
DELETE
/orders/{direction}/{orderID}
Delete an order
deleteOrder 2 params → 204401404
POST
/orders/{direction}/{orderID}/submit
Submit an order
submitOrder 2 params → 200400401404
GET
/orders/{direction}/{orderID}/lineitems
List order line items
listLineItems 2 params → 200401404
POST
/orders/{direction}/{orderID}/lineitems
Create a line item
createLineItem 2 params body → 201400401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Order_2 (17 properties), Address (11 properties), Order (8 properties), LineItem (7 properties). Each schema is shown below with its type and property counts.

CreateOrderRequest
object
Request body for creating or updating an order record
5 properties 2 required
ErrorResponse
object
An error response body
3 properties
OrderItem
object
A line item within an order representing a purchased product
6 properties
Order
object
A purchase transaction record associated with a guest profile
8 properties
CreateOrderRequest_2
object
Request body for creating or updating an order
4 properties
LineItemListResponse
object
A paginated list of order line items
2 properties
CreateLineItemRequest
object
Request body for creating a line item
4 properties 2 required
Address
object
A shipping or billing address
11 properties
Order_2
object
An order in the OrderCloud marketplace
17 properties
ErrorDetail
object
A single error detail
3 properties
OrderListResponse
object
A paginated list of orders
2 properties
UserReference
object
A reference to a user who placed or owns an order
5 properties
LineItem
object
A line item within an OrderCloud order
7 properties
ErrorResponse_2
object
An error response body
1 property
ListMetadata
object
Pagination metadata for list responses
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sitecore-orders-api-openapi.yml Raw ↑

Other APIs Sitecore publishes across the network.

Sitecore XM Cloud GraphQL Delivery API
Sitecore XM Cloud Authoring and Management GraphQL API
Sitecore CDP Stream API
Sitecore CDP Batch API
Sitecore Content Hub Admin API
sitecore Audit API
sitecore Authentication API
sitecore Buyers API
sitecore Collections API
sitecore Connections API
sitecore Decision Models API
sitecore Download Orders API
Where this information came from

This is an independent, third-party profile of sitecore 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.