Shopify

Shopify Order API

The Order API from Shopify — 129 operation(s) for order.

GitHub OpenAPI
Business capability
Order Fulfilment Management BC-520.40

Operations 16

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

POST /admin/api/2020-01/orders.json Create an order (API 2020-01) · Shopify Creates An Order #
Ask an LLM
“How do I create a new order through the 2020-01 Admin API?”
“Can an app add an order to the store on API version 2020-01?”
Tell an agent
Create a new order in the store via the 2020-01 API.
Using version 2020-01, add an order record to my shop.
GET /admin/api/2020-01/orders/{order_id}.json Retrieve one order (API 2020-01) · Shopify Retrieves A Specific Order #
Ask an LLM
“What does a single order look like when fetched by ID on the 2020-01 API?”
“Can I limit which fields come back when I pull one order under 2020-01?”
Tell an agent
Fetch order {order_id} with the 2020-01 API.
Using version 2020-01, show only {fields} for order {order_id}.
PUT /admin/api/2020-01/orders/{order_id}.json Update an order (API 2020-01) · Shopify Updates An Order #
Ask an LLM
“Which 2020-01 endpoint changes an existing order?”
“Is editing an order I already have allowed in API version 2020-01?”
Tell an agent
Update order {order_id} through the 2020-01 API.
On version 2020-01, save edits to existing order {order_id}.
POST /admin/api/2020-01/orders/{order_id}/close.json Close an order (API 2020-01) · Shopify Closes An Order #
Ask an LLM
“How do I close an order once it is complete, using 2020-01?”
“Can I mark an order as closed with the 2020-01 Admin API?”
Tell an agent destructive · confirm first
Close order {order_id} via API version 2020-01.
Using 2020-01, mark finished order {order_id} closed.
POST /admin/api/2020-01/orders/{order_id}/open.json Re-open a closed order (API 2020-01) · Shopify Re-opens A Closed Order #
Ask an LLM
“Can a closed order be re-opened on the 2020-01 API?”
“What 2020-01 call brings a closed order back to open?”
Tell an agent
Re-open closed order {order_id} with the 2020-01 API.
On version 2020-01, bring order {order_id} back from closed to open.
POST /admin/api/2020-04/orders.json Create an order (API 2020-04) · Shopify Creates An Order #
Ask an LLM
“Which April 2020 (2020-04) endpoint places a new order in my shop?”
“Is order creation available to apps in the 2020-04 release?”
Tell an agent
Place a new order in my shop on the 2020-04 release.
With the April 2020 endpoint, create an order.
GET /admin/api/2020-04/orders/{order_id}.json Retrieve one order (API 2020-04) · Shopify Retrieves A Specific Order #
Ask an LLM
“Where do I look up a specific order by its ID in the April 2020 (2020-04) API?”
“Can the 2020-04 order lookup return just the fields I pick?”
Tell an agent
Look up order {order_id} on the 2020-04 release.
Return fields {fields} of order {order_id} with the April 2020 endpoint.
PUT /admin/api/2020-04/orders/{order_id}.json Update an order (API 2020-04) · Shopify Updates An Order #
Ask an LLM
“Which April 2020 endpoint modifies an order that already exists?”
“Are order edits supported in the 2020-04 release of the Admin API?”
Tell an agent
Modify order {order_id} on the 2020-04 release.
Apply changes to order {order_id} using the April 2020 endpoint.
POST /admin/api/2020-04/orders/{order_id}/close.json Close an order (API 2020-04) · Shopify Closes An Order #
Ask an LLM
“What closes out a completed order in the April 2020 (2020-04) API?”
“Can orders be closed from an app on the 2020-04 release?”
Tell an agent destructive · confirm first
Close out order {order_id} on the 2020-04 release.
With the April 2020 endpoint, set order {order_id} to closed.
POST /admin/api/2020-04/orders/{order_id}/open.json Re-open a closed order (API 2020-04) · Shopify Re-opens A Closed Order #
Ask an LLM
“Which April 2020 (2020-04) endpoint re-opens an order I closed?”
“Is it possible to undo closing an order in the 2020-04 release?”
Tell an agent
Undo the close on order {order_id} using the 2020-04 release.
Re-open order {order_id} with the April 2020 endpoint.
POST /admin/api/2020-01/orders/{order_id}/risks.json Record a fraud risk on an order (API 2020-01) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“How do I flag an order as risky with the 2020-01 order risk endpoint?”
“Can my fraud app attach a risk assessment to an order on 2020-01?”
Tell an agent
Create an order risk on order {order_id} via the 2020-01 API.
Using version 2020-01, attach a fraud risk assessment to order {order_id}.
POST /admin/api/2020-04/orders/{order_id}/risks.json Record a fraud risk on an order (API 2020-04) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“Which April 2020 (2020-04) endpoint adds an order risk to an order?”
“Is recording fraud risk for an order supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, add an order risk to order {order_id}.
Record fraud risk for order {order_id} with the April 2020 endpoint.
POST /admin/api/2020-07/orders/{order_id}/risks.json Record a fraud risk on an order (API 2020-07) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“My fraud tool targets 2020-07; what creates an order risk there?”
“Can the July 2020 API store a risk signal against a suspicious order?”
Tell an agent
Store a risk signal on suspicious order {order_id} using July 2020 (2020-07).
With API 2020-07, create a risk record for order {order_id}.
POST /admin/api/2020-10/orders/{order_id}/risks.json Record a fraud risk on an order (API 2020-10) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“What is the 2020-10 call for adding an order risk?”
“Does the October 2020 API let me warn merchants that an order may be fraudulent?”
Tell an agent
Warn that order {order_id} may be fraudulent by adding a risk on the October 2020 version.
Add a 2020-10 order risk to order {order_id}.
POST /admin/api/2021-01/orders/{order_id}/risks.json Record a fraud risk on an order (API 2021-01) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“Under the 2021-01 API, where do I create an order risk?”
“Can I mark an order as high risk with the January 2021 API version?”
Tell an agent
Mark order {order_id} with a risk through API version 2021-01.
Log a fraud risk entry on order {order_id} against January 2021.
POST /admin/api/unstable/orders/{order_id}/risks.json Record a fraud risk on an order (unstable API) · Shopify Creates An Order Risk For An Order #
Ask an LLM
“Is there an unstable-channel endpoint for creating an order risk?”
“Can I test order risk creation against the unstable API version?”
Tell an agent
Create an order risk for order {order_id} on the unstable API.
Against the unstable version, test flagging order {order_id} as risky.

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-order-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/shopify-order-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shopify-order-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Order API
  description: Explore Shopify's API reference and templating documentation. Shopify provides a range of software tools, app templates, example apps, and libraries to accelerate your development process. The Admin API lets you build apps and integrations that extend and enhance the Shopify admin.
  version: 2020-10
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-order-api-openapi.yml