Optimizely Orders API

Manage purchase orders, cart operations, and order workflows.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /commerce/orders/{customerId}/all List all orders for a customer · List customer orders #

Ask an LLM

“How do I get every order a specific customer has placed?”

“Can I pull a customer's complete order list from the commerce service?”

Tell an agent

List all orders for customer {customerId}.

Show the full order history of customer {customerId}.

GET /commerce/orders/{orderGroupId} Get an order by its order group id · Get an order #

Ask an LLM

“How do I retrieve one commerce order using its order group id?”

“What's in a specific order group?”

Tell an agent

Get order group {orderGroupId}.

Show me the order with order group id {orderGroupId}.

GET /commerce/orders/search/{start}/{maxCount} Page through commerce orders · Search orders #

Ask an LLM

“How do I search commerce orders a page at a time?”

“Can I set a start offset and a maximum count when searching orders?”

Tell an agent

Search orders starting at {start}, returning at most {maxCount}.

Fetch the first {maxCount} orders from offset {start}.

GET /api/v1/orders Find the storefront user's orders by filters · Orders V1 get collection async #

Ask an LLM

“How do I find my orders by PO number or status on the storefront?”

“Can I filter storefront order history by date range or order total?”

Tell an agent

Find orders with PO number {poNumber}.

List my orders with status {status} placed between {fromDate} and {toDate}.

GET /api/v1/orders/{orderId} Get a storefront order by order id · Orders V1 get async #

Ask an LLM

“How do I view the lines and totals of one storefront order?”

“Can I look up a single order in order history by its order id?”

Tell an agent

Get storefront order {orderId}.

Show the lines and shipping for order {orderId}.

PATCH /api/v1/orders/{orderId} Update a storefront order · Orders V1 patch async #

Ask an LLM

“How do I change the status of a storefront order?”

“Can I update the PO number or notes on an existing order?”

Tell an agent

Set the status of order {orderId} to {status}.

Update order {orderId} with customer PO {customerPO}.

POST /api/v1/orders/{orderId}/returns Request a return (RMA) on an order · Orders V1 post rma async #

Ask an LLM

“How do I request a return authorization for items on an order?”

“Can I add notes explaining why I'm returning part of an order?”

Tell an agent

Request a return on order {orderId} for lines {rmaLines}.

Submit an RMA for order {orderId} with notes {notes}.

POST /api/v1/orders/shareorder Share an order by email · Orders V1 post #

Ask an LLM

“How do I email a copy of an order to a colleague?”

“Can I add a subject and message when sharing an order?”

Tell an agent

Share order {entityId} by email with {emailTo}.

Email order {entityId} to {emailTo} with subject {subject}.

Optimizely Orders API

Operations 8

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification