Shopify REST Admin API

https://shopify.dev/docs/api/admin-rest/latest
Admin
The Shopify REST Admin API allows developers to build apps and integrations that extend and enhance...
Tokens:165,207
Snippets:772
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### order.discount_codes example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Example of the discount_codes array structure for an order.

```json
order.discount_codes:[{"code":"FAKE30","amount":"9.00","type":"percentage"}]
```

--------------------------------

### Example line_items array

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the line_items array for an order.

```json
order.line_items:[{"variant_id":447654529,"quantity":1}]
```

--------------------------------

### Example email string

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the email field for an order.

```json
order.email:"jane@example.com"
```

--------------------------------

### Line item discount examples

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Examples of applied_discount objects for fixed amount and percentage discounts.

```json
applied_discount: { "value_type": "fixed_amount", "value": 5, "amount": 10 }
```

```json
applied_discount: { "value_type": "percentage", "value": 15, "amount": 5.99 }
```

--------------------------------

### order.line_items example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Example of the line_items array structure for an order.

```json
order.line_items:[{"title":"Red Leather Coat","price":129.99,"grams":"1700","quantity":1},{"title":"Blue Suede Shoes","price":85.95,"grams":"750","quantity":1,"taxable":false},{"title":"Raspberry Beret","price":19.99,"grams":"320","quantity":2}]
```

--------------------------------

### Refund Response Example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/refund

An example of a successful HTTP 201 response after creating a refund.

```http
HTTP/1.1 201 Created{"refund":{"order_id":450789469,"id":943333777,"created_at":"2026-07-01T12:19:51-04:00","note":"wrong size","user_id":null,"processed_at":"2026-07-01T12:19:51-04:00","duties":[],"total_duties_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"return":null,"refund_shipping_lines":[],"restock":false,"additional_fees":[],"total_additional_fees_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"admin_graphql_api_id":"gid://shopify/Refund/943333777","order_adjustments":[],"refund_line_items":[{"location_id":null,"restock_type":"no_restock","line_item_id":518995019,"quantity":1,"id":1058498322,"subtotal":0,"total_tax":0,"subtotal_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"total_tax_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"line_item":{"id":518995019,"variant_id":49148385,"title":"IPod Nano - 8gb","quantity":1,"sku":"IPOD2008RED","variant_title":"red","vendor":null,"fulfillment_service":"manual","product_id":632910392,"requires_shipping":true,"taxable":true,"gift_card":false,"name":"IPod Nano - 8gb - red","variant_inventory_management":"shopify","properties":[],"product_exists":true,"fulfillable_quantity":1,"grams":200,"price":"199.00","total_discount":"0.00","fulfillment_status":null,"price_set":{"shop_money":{"amount":"199.00","currency_code":"USD"},"presentment_money":{"amount":"199.00","currency_code":"USD"}},"total_discount_set":{"shop_money":{"amount":"0.00","currency_code":"USD"},"presentment_money":{"amount":"0.00","currency_code":"USD"}},"discount_allocations":[{"amount":"3.33","discount_application_index":0,"amount_set":{"shop_money":{"amount":"3.33","currency_code":"USD"},"presentment_money":{"amount":"3.33","currency_code":"USD"}}}],"duties":[],"admin_graphql_api_id":"gid://shopify/LineItem/518995019","tax_lines":[{"title":"State Tax","price":"3.98","rate":0.06,"channel_liable":null,"price_set":{"shop_money":{"amount":"3.98","currency_code":"USD"},"presentment_money":{"amount":"3.98","currency_code":"USD"}}}]}}],"transactions":[{"id":1068278534,"order_id":450789469,"kind":"refund","gateway":"bogus","status":"success","message":"Bogus Gateway: Forced success","created_at":"2026-07-01T12:19:51-04:00","test":true,"authorization":null,"location_id":null,"user_id":null,"parent_id":801038806,"processed_at":"2026-07-01T12:19:51-04:00","device_id":null,"error_code":null,"source_name":"755357713","receipt":{},"currency_exchange_adjustment":null,"amount":"41.94","currency":"USD","payment_id":"#1001.4","total_unsettled_set":{"presentment_money":{"amount":"348.0","currency":"USD"},"shop_money":{"amount":"348.0","currency":"USD"}},"manual_payment_gateway":false,"amount_rounding":null,"admin_graphql_api_id":"gid://shopify/OrderTransaction/1068278534"}]}}
```

--------------------------------

### order.financial_status example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Example of the financial_status string value for an order.

```json
order.financial_status:"paid"
```

--------------------------------

### Example order.total_tax value

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the total_tax field representing the sum of all tax lines.

```text
order.total_tax:14.45
```

--------------------------------

### Example shipping_address object

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the shipping_address object structure for an order.

```json
order.shipping_address:{"first_name":"Jane","last_name":"Smith","address1":"123 Fake Street","phone":"777-777-7777","city":"Fakecity","province":"Ontario","country":"Canada","zip":"K2P 1L4"}
```

--------------------------------

### Example financial_status value

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the financial_status field for an order.

```json
order.financial_status:"partially_paid"
```

--------------------------------

### Example order.line_items array

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the line_items array containing a line item with nested tax_lines.

```json
order.line_items:[{"title":"Clicky Keyboard","price":99.99,"grams":"600","quantity":1,"tax_lines":[{"price":1,"rate":0.01,"title":"Keyboard tax"}]}]
```

--------------------------------

### Order resource structure

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Example JSON structure of an Order resource.

```json
{
"app_id": 1966818,
"billing_address": {
"address1": "2259 Park Ct",
"address2": "Apartment 5",
"city": "Drayton Valley",
"company": null,
"country": "Canada",
"first_name": "Christopher",
"last_name": "Gorski",
"phone": "(555)555-5555",
"province": "Alberta",
"zip": "T0E 0M0",
"name": "Christopher Gorski",
"province_code": "AB",
"country_code": "CA",
"latitude": "45.41634",
"longitude": "-75.6868"
},
"browser_ip": "216.191.105.146",
"buyer_accepts_marketing": false,
"cancel_reason": "customer",
"cancelled_at": null,
"cart_token": "68778783ad298f1c80c3bafcddeea",
"checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
"client_details": {
"accept_language": "en-US,en;q=0.9",
"browser_height": 1320,
"browser_ip": "216.191.105.146",
"browser_width": 1280,
"session_hash": "9ad4d1f4e6a8977b9dd98eed1e477643",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36"
},
"closed_at": "2008-01-10T11:00:00-05:00",
"company": {
"id": 182772
```

--------------------------------

### Create an order using PHP SDK

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Initializes a session and creates an order with receipt flags set to true.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->send_receipt = true;
$order->send_fulfillment_receipt = true;
$order->line_items = [{"variant_id":457924702,"quantity":1}];
$order->post(
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->send_receipt = true;
$order->send_fulfillment_receipt = true;
$order->line_items = [{"variant_id":457924702,"quantity":1}];
$order->post(
    test_session,
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->send_receipt = true;
$order->send_fulfillment_receipt = true;
$order->line_items = [{"variant_id":457924702,"quantity":1}];
$order->post(
);
```

--------------------------------

### Create an order using PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Initializes a session and creates an order object with line items, customer details, and discount codes, then executes the post method.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->email = "jane@example.com";
$order->phone = "18885551234";
$order->billing_address = {"first_name":"John","last_name":"Smith","address1":"123 Fake Street","phone":"555-555-5555","city":"Fakecity","province":"Ontario","country":"Canada","zip":"K2P 1L4"};
$order->shipping_address = {"first_name":"Jane","last_name":"Smith","address1":"123 Fake Street","phone":"777-777-7777","city":"Fakecity","province":"Ontario","country":"Canada","zip":"K2P 1L4"};
$order->transactions = [{"kind":"sale","status":"success","amount":50}];
$order->financial_status = "paid";
$order->discount_codes = [{"code":"FAKE30","amount":"9.00","type":"percentage"}];
$order->post(
);
```

--------------------------------

### Create an order with PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Create an order using the Shopify PHP library. This example initializes a session and posts the order details.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->fulfillments = [{"location_id":24826418}];
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->post(
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->fulfillments = [{"location_id":24826418}];
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->post(
    test_session,
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->email = "foo@example.com";
$order->fulfillment_status = "fulfilled";
$order->fulfillments = [{"location_id":24826418}];
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->post(
);
```

--------------------------------

### Create a pending order with an existing customer using PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

This PHP example demonstrates creating an order using the Shopify REST Admin library.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->customer = {"id":207119551};
$order->financial_status = "pending";
$order->post(
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->customer = {"id":207119551};
$order->financial_status = "pending";
$order->post(
    test_session,
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"variant_id":447654529,"quantity":1}];
$order->customer = {"id":207119551};
$order->financial_status = "pending";
$order->post(
);
```

--------------------------------

### Create a draft order with a discount

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Example request body for creating a draft order with a custom line item and a fixed amount discount.

```json
draft_order.line_items:[{"title":"Custom Tee","price":"20.00","quantity":2}]
```

```json
draft_order.applied_discount:{"description":"Custom discount","value_type":"fixed_amount","value":"10.0","amount":"10.00","title":"Custom"}
```

--------------------------------

### Create a DraftOrder

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Initializes a session and creates a draft order with specified line items and billing address.

```php
use Shopify\Rest\Admin2026_07\DraftOrder;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$draft_order = new DraftOrder($this->test_session);
$draft_order->line_items = [{"variant_id":447654529,"quantity":1}];
$draft_order->billing_address = {"first_name":"Bob","last_name":"Norman","address1":"123 Main St","city":"Anytown","province":"ON","country":"Canada","zip":"A1B2C3","phone":"555-555-5555"};
$draft_order->post(
);
```

--------------------------------

### Example order.tax_lines array

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

An example of the tax_lines array structure containing multiple tax objects.

```json
order.tax_lines:[{"price":10.2,"rate":0.06,"title":"State tax"},{"price":4.25,"rate":0.025,"title":"County tax"}]
```

--------------------------------

### Create an order with tax lines using PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Creates an order with tax lines using the Shopify PHP library. This example assumes a valid session is loaded.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"title":"Red Leather Coat","price":129.99,"grams":"1700","quantity":1},{"title":"Blue Suede Shoes","price":85.95,"grams":"750","quantity":1,"taxable":false},{"title":"Raspberry Beret","price":19.99,"grams":"320","quantity":2}];
$order->tax_lines = [{"price":10.2,"rate":0.06,"title":"State tax"},{"price":4.25,"rate":0.025,"title":"County tax"}];
$order->total_tax = 14.45;
$order->post(
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"title":"Red Leather Coat","price":129.99,"grams":"1700","quantity":1},{"title":"Blue Suede Shoes","price":85.95,"grams":"750","quantity":1,"taxable":false},{"title":"Raspberry Beret","price":19.99,"grams":"320","quantity":2}];
$order->tax_lines = [{"price":10.2,"rate":0.06,"title":"State tax"},{"price":4.25,"rate":0.025,"title":"County tax"}];
$order->total_tax = 14.45;
$order->post(
    test_session,
);
```

--------------------------------

### Transaction Response Example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/transaction

Example of a successful HTTP 201 response body for a transaction operation.

```http
HTTP/1.1 201 Created{"transaction":{"id":1068278516,"order_id":450789469,"kind":"capture","gateway":"bogus","status":"success","message":"Bogus Gateway: Forced success","created_at":"2026-07-02T10:42:18-04:00","test":true,"authorization":null,"location_id":null,"user_id":null,"parent_id":389404469,"processed_at":"2026-07-02T10:42:18-04:00","device_id":null,"error_code":null,"source_name":"755357713","payment_details":{"credit_card_bin":null,"avs_result_code":null,"cvv_result_code":null,"credit_card_number":"•••• •••• •••• 4242","credit_card_company":"Visa","buyer_action_info":null,"credit_card_name":null,"credit_card_wallet":null,"credit_card_expiration_month":null,"credit_card_expiration_year":null,"payment_method_name":"visa"},"receipt":{},"currency_exchange_adjustment":null,"amount":"10.00","currency":"USD","payment_id":"#1001.2","total_unsettled_set":{"presentment_money":{"amount":"588.94","currency":"USD"},"shop_money":{"amount":"588.94","currency":"USD"}},"manual_payment_gateway":false,"amount_rounding":null,"admin_graphql_api_id":"gid://shopify/OrderTransaction/1068278516"}}
```

```http
HTTP/1.1 201 Created{"transaction":{"id":1068278521,"order_id":450789469,"kind":"void","gateway":"bogus","status":"success","message":"Bogus Gateway: Forced success","created_at":"2026-07-02T10:42:21-04:00","test":true,"authorization":null,"location_id":null,"user_id":null,"parent_id":389404469,"processed_at":"2026-07-02T10:42:21-04:00","device_id":null,"error_code":null,"source_name":"755357713","payment_details":{"credit_card_bin":null,"avs_result_code":null,"cvv_result_code":null,"credit_card_number":"•••• •••• •••• 4242","credit_card_company":"Visa","buyer_action_info":null,"credit_card_name":null,"credit_card_wallet":null,"credit_card_expiration_month":null,"credit_card_expiration_year":null,"payment_method_name":"visa"},"receipt":{},"currency_exchange_adjustment":null,"amount":"0.00","currency":"USD","payment_id":"#1001.2","total_unsettled_set":{"presentment_money":{"amount":"0.0","currency":"USD"},"shop_money":{"amount":"0.0","currency":"USD"}},"manual_payment_gateway":false,"amount_rounding":null,"admin_graphql_api_id":"gid://shopify/OrderTransaction/1068278521"}}
```

--------------------------------

### Draft order line_items property example

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Example of the line_items property structure for a custom line item in a draft order.

```json
{"title":"Custom Tee","price":"20.00","quantity":2}
```

--------------------------------

### Create an order risk using PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order-risk

Example of creating an order risk assessment using the Shopify PHP library.

```php
use Shopify\Rest\Admin2026_07\OrderRisk;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order_risk = new OrderRisk($this->test_session);
$order_risk->message = "This order came from an anonymous proxy";
$order_risk->recommendation = "cancel";
$order_risk->score = "1.0";
$order_risk->source = "External";
$order_risk->cause_cancel = true;
$order_risk->display = true;
$order_risk->post(
    450789469,
);
```

```php
use Shopify\Rest\Admin2026_07\OrderRisk;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order_risk = new OrderRisk($this->test_session);
$order_risk->message = "This order came from an anonymous proxy";
$order_risk->recommendation = "cancel";
$order_risk->score = "1.0";
$order_risk->source = "External";
$order_risk->cause_cancel = true;
$order_risk->display = true;
$order_risk->post(
    test_session,
    450789469,
);
```

```php
use Shopify\Rest\Admin2026_07\OrderRisk;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order_risk = new OrderRisk($this->test_session);
$order_risk->message = "This order came from an anonymous proxy";
$order_risk->recommendation = "cancel";
$order_risk->score = "1.0";
$order_risk->source = "External";
$order_risk->cause_cancel = true;
$order_risk->display = true;
$order_risk->post(
    450789469,
);
```

--------------------------------

### Create a simple order using cURL

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Creates an order with a specific product variant ID and quantity using a POST request to the orders endpoint.

```bash
curl -d '{"order":{"line_items":[{"variant_id":447654529,"quantity":1}]}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/orders.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
```

--------------------------------

### GET /admin/api/latest/orders/count.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Retrieves the count of orders.

```APIDOC
## GET /admin/api/latest/orders/count.json

### Description
Retrieve an order count.

### Method
GET

### Endpoint
/admin/api/latest/orders/count.json

### Parameters
#### Query Parameters
- **status** (string) - Optional - The status of orders to count.
```

--------------------------------

### Create a draft order with PHP and test session

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Create a draft order using the DraftOrder class while explicitly passing the test session to the post method.

```php
use Shopify\Rest\Admin2026_07\DraftOrder;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$draft_order = new DraftOrder($this->test_session);
$draft_order->line_items = [{"title":"Custom Tee","price":"20.00","quantity":1,"applied_discount":{"description":"Custom discount","value_type":"fixed_amount","value":"10.0","amount":"10.0","title":"Custom"}}];
$draft_order->post(
    test_session,
);
```

--------------------------------

### GET /admin/api/latest/orders.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Retrieves a list of orders.

```APIDOC
## GET /admin/api/latest/orders.json

### Description
Retrieve a list of orders.

### Method
GET

### Endpoint
/admin/api/latest/orders.json

### Parameters
#### Query Parameters
- **status** (string) - Optional - The status of orders to retrieve.
```

--------------------------------

### GET /admin/api/checkouts/count.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Counts all abandoned checkouts.

```APIDOC
## GET /admin/api/checkouts/count.json

### Description
Returns a count of all abandoned checkouts.

### Method
GET

### Endpoint
/admin/api/checkouts/count.json
```

--------------------------------

### GET /admin/api/latest/draft_orders.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Retrieves a list of all draft orders.

```APIDOC
## GET /admin/api/latest/draft_orders.json

### Description
Retrieves a list of draft orders.

### Method
GET

### Endpoint
/admin/api/latest/draft_orders.json
```

--------------------------------

### Create a draft order with a discount using cURL

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Sends a POST request to create a draft order with line items, a fixed amount discount, and customer information.

```bash
curl -d '{"draft_order":{"line_items":[{"title":"Custom Tee","price":"20.00","quantity":2}],"applied_discount":{"description":"Custom discount","value_type":"fixed_amount","value":"10.0","amount":"10.00","title":"Custom"},"customer":{"id":207119551},"use_customer_default_address":true}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/draft_orders.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
```

--------------------------------

### GET /admin/api/checkouts.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Retrieves a list of abandoned checkouts.

```APIDOC
## GET /admin/api/checkouts.json

### Description
Retrieves a list of abandoned checkouts for the shop.

### Method
GET

### Endpoint
/admin/api/checkouts.json

### Response
#### Success Response (200)
- **checkouts** (array) - A list of abandoned checkout objects.

#### Response Example
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "email": "bob.norman@mail.example.com",
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover",
      "total_price": "379.69",
      "currency": "USD"
    }
  ]
}
```

--------------------------------

### Create Draft Order via cURL

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Example of creating a draft order using a product variant ID via a POST request.

```bash
curl -d '{"draft_order":{"line_items":[{"variant_id":447654529,"quantity":1}]}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/draft_orders.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
```

--------------------------------

### GET /admin/api/checkouts.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Retrieves a list of abandoned checkouts.

```APIDOC
## GET /admin/api/checkouts.json

### Description
Retrieves a list of abandoned checkouts.

### Method
GET

### Endpoint
/admin/api/checkouts.json

### Response
#### Success Response (200)
- **checkouts** (array) - A list of abandoned checkout objects.

#### Response Example
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "email": "bob.norman@mail.example.com",
      "total_price": "379.69",
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover"
    }
  ]
}
```

--------------------------------

### Create an order and apply a discount using cURL

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Sends a POST request to the orders endpoint to create a new order with specified line items, addresses, and a discount code.

```bash
curl -d '{"order":{"line_items":[{"variant_id":447654529,"quantity":1}],"email":"jane@example.com","phone":"18885551234","billing_address":{"first_name":"John","last_name":"Smith","address1":"123 Fake Street","phone":"555-555-5555","city":"Fakecity","province":"Ontario","country":"Canada","zip":"K2P 1L4"},"shipping_address":{"first_name":"Jane","last_name":"Smith","address1":"123 Fake Street","phone":"777-777-7777","city":"Fakecity","province":"Ontario","country":"Canada","zip":"K2P 1L4"},"transactions":[{"kind":"sale","status":"success","amount":50}],"financial_status":"paid","discount_codes":[{"code":"FAKE30","amount":"9.00","type":"percentage"}]}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/orders.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
```

--------------------------------

### GET /checkouts

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Retrieves a list of all abandoned checkouts.

```APIDOC
## GET /checkouts

### Description
Retrieves a list of all abandoned checkouts.

### Method
GET

### Endpoint
/checkouts

### Response
#### Success Response (200)
- **checkouts** (array) - A list of abandoned checkout objects.

#### Response Example
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "email": "bob.norman@mail.example.com",
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover",
      "total_price": "379.69",
      "currency": "USD"
    }
  ]
}
```

--------------------------------

### GET /checkouts

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Retrieves a list of abandoned checkouts.

```APIDOC
## GET /checkouts

### Description
Retrieves a list of abandoned checkouts from the store.

### Method
GET

### Endpoint
/checkouts

### Response
#### Success Response (200)
- **checkouts** (array) - A list of abandoned checkout objects.

#### Response Example
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "email": "bob.norman@mail.example.com",
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover",
      "total_price": "379.69",
      "currency": "USD"
    }
  ]
}
```

--------------------------------

### Create a comprehensive order using PHP

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Uses the Shopify PHP library to instantiate an Order object and post it to the API.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"title":"Big Brown Bear Boots","price":74.99,"grams":"1300","quantity":3,"tax_lines":[{"price":13.5,"rate":0.06,"title":"State tax"}]}];
$order->transactions = [{"kind":"sale","status":"success","amount":238.47}];
$order->total_tax = 13.5;
$order->currency = "EUR";
$order->post(
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"title":"Big Brown Bear Boots","price":74.99,"grams":"1300","quantity":3,"tax_lines":[{"price":13.5,"rate":0.06,"title":"State tax"}]}];
$order->transactions = [{"kind":"sale","status":"success","amount":238.47}];
$order->total_tax = 13.5;
$order->currency = "EUR";
$order->post(
    test_session,
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$order = new Order($this->test_session);
$order->line_items = [{"title":"Big Brown Bear Boots","price":74.99,"grams":"1300","quantity":3,"tax_lines":[{"price":13.5,"rate":0.06,"title":"State tax"}]}];
$order->transactions = [{"kind":"sale","status":"success","amount":238.47}];
$order->total_tax = 13.5;
$order->currency = "EUR";
$order->post(
);
```

--------------------------------

### GET /admin/api/checkouts.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts

Retrieves a list of abandoned checkouts.

```APIDOC
## GET /admin/api/checkouts.json

### Description
Retrieves a list of abandoned checkouts.

### Method
GET

### Endpoint
/admin/api/checkouts.json

### Response
#### Success Response (200)
- **checkouts** (array) - A list of abandoned checkout objects.

#### Response Example
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "email": "bob.norman@mail.example.com",
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover"
    }
  ]
}
```

--------------------------------

### Retrieve all orders via PHP (Order::all)

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/order

Example using the Shopify PHP library to retrieve all orders via the Order::all method.

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$response = Order::all(
    any,
);
```

```php
use Shopify\Rest\Admin2026_07\Order;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$response = Order::all(
    any,
);
```

--------------------------------

### GET /admin/api/2026-07/draft_orders.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Retrieves a list of all draft orders for the store.

```APIDOC
## GET /admin/api/2026-07/draft_orders.json

### Description
Retrieves a list of all draft orders associated with the Shopify store.

### Method
GET

### Endpoint
/admin/api/2026-07/draft_orders.json

### Response
#### Success Response (200)
- **draft_orders** (array) - A list of draft order objects.

#### Response Example
{
  "draft_orders": [
    {
      "id": 47884561,
      "note": null,
      "email": null,
      "taxes_included": false,
      "currency": "USD",
      "status": "open",
      "line_items": []
    }
  ]
}
```

--------------------------------

### GET /admin/api/latest/draft_orders/count.json

Source: https://shopify.dev/docs/api/admin-rest/latest/resources/draftorder

Retrieves the total count of draft orders.

```APIDOC
## GET /admin/api/latest/draft_orders/count.json

### Description
Receive a count of all DraftOrders.

### Method
GET

### Endpoint
/admin/api/latest/draft_orders/count.json
```
Tokens:
Raw