Shopify

Shopify Orders API

Manage orders

Documentation GitHub OpenAPI

Business capability

Operations 23

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 /orders.json List recent orders with filters · Shopify Retrieve a list of orders #

Ask an LLM

“Which of my store's orders from the last 60 days are still unfulfilled?”

“Can I include orders of any status, not just open ones, when listing?”

Tell an agent

List orders with status {status} created after {created_at_min}.

Show orders whose payment status is {financial_status}, up to {limit} of them.

POST /orders.json Record an order from an external channel · Shopify Create an order #

Ask an LLM

“How do I import a sale made on another channel as an order in Shopify?”

“Does creating an order through the API charge the customer's card?”

Tell an agent

Create an order from this sale: {order}.

Record an external-channel sale as a new order with details {order}.

GET /orders/count.json Count orders matching filters · Shopify Retrieve a count of orders #

Ask an LLM

“How many orders did I get since the start of the month?”

“Can I count only the orders that are paid but not yet shipped?”

Tell an agent

Count orders created since {created_at_min}.

Tell me how many orders have payment status {financial_status} and fulfillment status {fulfillment_status}.

GET /orders/{order_id}.json Get one order's details · Shopify Retrieve a single order #

Ask an LLM

“What line items and totals are on a specific order?”

“Can I fetch only certain fields of a single order?”

Tell an agent

Show me order {order_id}.

Get order {order_id} with only the fields {fields}.

PUT /orders/{order_id}.json Update an order's note, tags or contact info · Shopify Update an order #

Ask an LLM

“Can I change the shipping address on an order that's already been placed?”

“Which parts of an existing order, like tags or note, can be edited?”

Tell an agent

Update order {order_id} with {order}.

Change the note and tags on existing order {order_id} to {order}.

DELETE /orders/{order_id}.json Delete an order · Shopify Delete an order #

Ask an LLM

“Why can't I delete an order that was paid through an online gateway?”

“How do I permanently delete an order record from my store?”

Tell an agent destructive · confirm first

Delete order {order_id}.

Permanently remove order {order_id} from the store.

POST /orders/{order_id}/cancel.json Cancel an order and optionally restock · Shopify Cancel an order #

Ask an LLM

“How do I cancel an order and put the items back in stock?”

“Can I email the customer when I cancel their order?”

Tell an agent destructive · confirm first

Cancel order {order_id} with reason {reason}.

Cancel order {order_id}, restock items ({restock}) and send the cancellation email ({email}).

POST /orders/{order_id}/close.json Close an order as completed · Shopify Close an order #

Ask an LLM

“Can I mark a finished order as closed once it's done?”

“What does closing an order do to its status?”

Tell an agent destructive · confirm first

Close order {order_id}.

Mark order {order_id} as completed.

POST /orders/{order_id}/open.json Re-open a closed order · Shopify Re-open a closed order #

Ask an LLM

“Can I bring back an order I closed by mistake?”

“Is it possible to reopen an order that was marked completed?”

Tell an agent

Re-open closed order {order_id}.

Open order {order_id} back up after it was closed.

POST /admin/api/2020-01/orders/{order_id}/cancel.json Cancel an order with a refund amount (2020-01) · Shopify For Multi-currency Orders #

Ask an LLM

“How do I cancel a multi-currency order and refund a set amount with the 2020-01 API?”

“Which cancellation reasons does version 2020-01 accept — customer, inventory, fraud, declined, other?”

Tell an agent destructive · confirm first

Cancel order {order_id} on 2020-01 and refund {amount} {currency}.

Using API version 2020-01, cancel order {order_id} for reason {reason} and notify the customer ({email}).

POST /admin/api/2020-04/orders/{order_id}/cancel.json Cancel an order with a refund amount (2020-04) · Shopify For Multi-currency Orders #

Ask an LLM

“Can I void payment while cancelling an order on release 2020-04?”

“Does the 2020-04 cancel call need a currency when I pass a refund amount?”

Tell an agent destructive · confirm first

Through 2020-04, cancel order {order_id}, refunding {amount} in {currency}.

Cancel order {order_id} as {reason} via the 2020-04 endpoint, email flag {email}.

POST /admin/api/2020-01/orders/{order_id}/refunds.json Issue a refund on an order (2020-01) · Shopify For Multi-currency Orders #

Ask an LLM

“How do I refund specific line items on an order with the 2020-01 API?”

“Can version 2020-01 notify the customer when I issue a refund?”

Tell an agent

Refund line items {refund_line_items} on order {order_id} using 2020-01.

On 2020-01, issue a refund for order {order_id} and set customer notification to {notify}.

POST /admin/api/2020-01/orders/{order_id}/refunds/calculate.json Preview what a refund would be (2020-01) · Shopify For Multi-currency Orders #

Ask an LLM

“How do I work out how much a refund would be before issuing it with the 2020-01 API?”

“Can version 2020-01 calculate refundable shipping for an order?”

Tell an agent

Calculate the refund for line items {refund_line_items} on order {order_id} using 2020-01.

On 2020-01, estimate refundable shipping {shipping} for order {order_id}.

POST /admin/api/2020-04/orders/{order_id}/refunds.json Issue a refund on an order (2020-04) · Shopify For Multi-currency Orders #

Ask an LLM

“Can I refund shipping costs as well as items using release 2020-04?”

“Is it possible to attach a note to a refund in 2020-04?”

Tell an agent

Refund shipping {shipping} in {currency} on order {order_id} via 2020-04.

Using 2020-04, refund items {refund_line_items} from order {order_id} with note {note}.

POST /admin/api/2020-04/orders/{order_id}/refunds/calculate.json Preview what a refund would be (2020-04) · Shopify For Multi-currency Orders #

Ask an LLM

“Can I get the transactions a refund would need, without refunding, on release 2020-04?”

“Does the 2020-04 refund calculation need a currency when shipping is included?”

Tell an agent

Preview a refund of items {refund_line_items} from order {order_id} via 2020-04.

Using 2020-04, compute the shipping refund {shipping} in {currency} for order {order_id}.

POST /admin/api/2020-07/orders/{order_id}/refunds.json Issue a refund on an order (2020-07) · Shopify For Multi-currency Orders #

Ask an LLM

“Is there a 2020-07 endpoint to create a refund for an order?”

“Can I explain why the refunded amount differs from the calculated one on 2020-07?”

Tell an agent

Create a refund on order {order_id} processing transactions {transactions} through 2020-07.

Refund order {order_id} on 2020-07 with discrepancy reason {discrepancy_reason}.

POST /admin/api/2020-07/orders/{order_id}/refunds/calculate.json Preview what a refund would be (2020-07) · Shopify For Multi-currency Orders #

Ask an LLM

“Is there a 2020-07 endpoint that calculates a refund without creating it?”

“Can I check refund totals for returned items on 2020-07?”

Tell an agent

Work out refund totals for returned items {refund_line_items} on order {order_id} through 2020-07.

Dry-run a shipping refund of {shipping} for order {order_id} on the 2020-07 API.

POST /admin/api/2020-10/orders/{order_id}/refunds.json Issue a refund on an order · Shopify For Multi-currency Orders #

Ask an LLM

“What call creates a refund on an order in the 2020-10 Admin API?”

“Can I choose which currency a refund is issued in on 2020-10?”

Tell an agent

Refund line items {refund_line_items} of order {order_id} with the 2020-10 Admin API.

Using 2020-10, refund {shipping} of shipping on order {order_id} in {currency}.

POST /admin/api/2020-10/orders/{order_id}/refunds/calculate.json Preview what a refund would be · Shopify For Multi-currency Orders #

Ask an LLM

“What call calculates a refund in the 2020-10 Admin API?”

“Before refunding on 2020-10, can I see what the refund transactions would be?”

Tell an agent

Calculate a refund for items {refund_line_items} of order {order_id} with the 2020-10 Admin API.

Using 2020-10, preview the shipping refund {shipping} in {currency} on order {order_id}.

POST /admin/api/2021-01/orders/{order_id}/refunds.json Issue a refund on an order (2021-01) · Shopify For Multi-currency Orders #

Ask an LLM

“Does the January 2021 (2021-01) API let me issue refunds?”

“Can I refund an order without emailing the customer on 2021-01?”

Tell an agent

Issue a quiet refund on order {order_id} via the 2021-01 version, notify set to {notify}.

With API version 2021-01, refund order {order_id} by processing refund transactions {transactions}.

POST /admin/api/2021-01/orders/{order_id}/refunds/calculate.json Preview what a refund would be (2021-01) · Shopify For Multi-currency Orders #

Ask an LLM

“Does the January 2021 (2021-01) API have a refund calculator?”

“Can I quote a customer their refund before processing it on 2021-01?”

Tell an agent

Quote the refund on order {order_id} for lines {refund_line_items} via the 2021-01 version.

With API version 2021-01, calculate refundable shipping {shipping} for order {order_id}.

POST /admin/api/unstable/orders/{order_id}/refunds.json Issue a refund on an order (unstable) · Shopify For Multi-currency Orders #

Ask an LLM

“Can I create an order refund through the unstable Admin API?”

“Does the unstable version accept refund line items with restock instructions?”

Tell an agent

Refund items {refund_line_items} on order {order_id} against the unstable API.

Use the unstable endpoint to refund order {order_id}, noting {note}, for items {refund_line_items}.

POST /admin/api/unstable/orders/{order_id}/refunds/calculate.json Preview what a refund would be (unstable) · Shopify For Multi-currency Orders #

Ask an LLM

“Can I calculate a refund through the unstable Admin API?”

“Does the unstable version compute refund amounts for shipping too?”

Tell an agent

Calculate a refund for order {order_id} lines {refund_line_items} against the unstable API.

Use the unstable endpoint to estimate a {shipping} shipping refund in {currency} for order {order_id}.

Shopify Orders API

Operations 23

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