Documentation Powered by Redocly

SHOPIFY (1.0)

Download OpenAPI specification:Download

Customers

Retrieve all customers for a shop

query Parameters
limit
required
string
since_id
required
string
fields
required
string
ids
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
page_info
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "customers": [
    ]
}

Create a new customer record

header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "customer": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "customer": {
    }
}

Retrieve a single customer by their ID

path Parameters
id
required
string
query Parameters
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Update details for a customer

path Parameters
id
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Customer2)

Responses

Request samples

Content type
application/json
{
  • "customer": {
    }
}

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Remove an existing customer

path Parameters
id
required
string

Responses

Retrieve a count of all customers

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve all orders from a customer

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Customer Address

Create a new address for a customer

path Parameters
customerId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Address3)

Responses

Request samples

Content type
application/json
{
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "address": {
    }
}

Retrieve all of a customers addresses

path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Update Customer Address

path Parameters
customerId
required
string
addressId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Address4)

Responses

Request samples

Content type
application/json
{
  • "address": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "address": {
    }
}

Remove a customer address

path Parameters
customerId
required
string
addressId
required
string

Responses

Retrieve a single customer address

path Parameters
customerId
required
string
addressId
required
string

Responses

Response samples

Content type
application/json
{
  • "customer_address": {
    }
}

Products

Creates a new product.

header Parameters
Content-Type
required
string
X-Shopify-Api-Features
string
Request Body schema: application/json
object (Product)

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

Retrieves a list of products

query Parameters
limit
required
string
since_id
required
string
fields
required
string
vendor
required
string
ids
required
string
title
required
string
handle
required
string
presentment_currency
required
string
product_type
required
string
collection_id
required
string
published_at_min
required
string
published_at_max
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
published_status
required
string
page_info
required
string
header Parameters
X-Shopify-Api-Features
string

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

Retrieves a single product

path Parameters
productId
required
string
query Parameters
fields
required
string
header Parameters
X-Shopify-Api-Features
string

Responses

Response samples

Content type
application/json
{
  • "product": {
    }
}

Deletes a product

path Parameters
productId
required
string

Responses

Updates a product

path Parameters
productId
required
string
header Parameters
Content-Type
required
string
X-Shopify-Api-Features
string
Request Body schema: application/json
object (Product1)

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

Retrieves a count of products

query Parameters
vendor
required
string
fields
required
string
product_type
required
string
collection_id
required
string
ids
required
string
title
required
string
published_at_min
required
string
published_at_max
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
published_status
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Product Variants

Retrieves a list of product variants

path Parameters
id
required
string
query Parameters
since_id
required
string
limit
required
string
presentment_currencies
required
string
fields
required
string
page_info
required
string
header Parameters
X-Shopify-Api-Features
string

Responses

Response samples

Content type
application/json
{
  • "variants": [
    ]
}

POST Create Product Variant

path Parameters
id
required
string
header Parameters
Content-Type
required
string
X-Shopify-Api-Features
string
Request Body schema: application/json
object (Variant5)

Responses

Request samples

Content type
application/json
{
  • "variant": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "variant": {
    }
}

Delete product variant by id

path Parameters
productId
required
string
id
required
string

Responses

Update existing product variant

path Parameters
id
required
string
header Parameters
Content-Type
required
string
X-Shopify-Api-Features
string
Request Body schema: application/json
object (Variant7)

Responses

Request samples

Content type
application/json
{
  • "variant": {
    }
}

Response samples

Content type
application/json
{
  • "variant": {
    }
}

Get Product variant by Id

path Parameters
id
required
string
query Parameters
fields
required
string
header Parameters
X-Shopify-Api-Features
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "variant": {
    }
}

Orders

List Abandoned Checkouts

query Parameters
limit
required
string
since_id
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
status
required
string
page_info
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "checkouts": [
    ]
}

Creates an order

header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Order)

Responses

Request samples

Content type
application/json
{
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Retrieves a list of orders

query Parameters
limit
required
string
since_id
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
status
required
string
fields
required
string
page_info
required
string
fulfillment_status
required
string
financial_status
required
string
attribution_app_id
required
string
processed_at_min
required
string
processed_at_max
required
string
ids
required
string

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Retrieve specific orders

path Parameters
orderId
required
string
query Parameters
fields
required
string

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

Update Order Details

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Order3)

Responses

Request samples

Content type
application/json
{
  • "order": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "order": {
    }
}

Delete an Order

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string

Responses

Retrieves an order count

query Parameters
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
status
required
string
fulfillment_status
required
string
financial_status
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Close an order

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "order": {
    }
}

Re-open a closed order

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "order": {
    }
}

Cancel an order

path Parameters
orderId
required
string

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

Locations

Retrieve a list of all locations

header Parameters
Accept
required
string
Content-Type
required
string

Responses

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

authentication

Product Images

Get Product Images by ID

path Parameters
productId
required
string
query Parameters
since_id
required
string
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "images": [
    ]
}

Create Product Image

path Parameters
productId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Image8)

Responses

Request samples

Content type
application/json
{
  • "image": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "image": {
    }
}

Count Product Images

path Parameters
productId
required
string
query Parameters
since_id
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get a single product image by image id id

path Parameters
productId
required
string
id
required
string
query Parameters
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "image": {
    }
}

Delete an image for a product

path Parameters
id
required
string
productId
required
string

Responses

Update Product Image by Id

path Parameters
productId
required
string
id
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Image10)

Responses

Request samples

Content type
application/json
{
  • "image": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "image": {
    }
}

Order fulfillment

Create Order Fulfillment

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Fulfillment3)

Responses

Request samples

Content type
application/json
{
  • "fulfillment": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Get Fulfillment for an Order

path Parameters
orderId
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillments": [
    ]
}

Update Fulfillment by id for an order

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Fulfillment4)

Responses

Request samples

Content type
application/json
{
  • "fulfillment": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Get Fulfillment by ID

path Parameters
orderId
required
string
fulfillmentId
required
string
query Parameters
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Get Fulfillment Count by Order ID

path Parameters
orderId
required
string
query Parameters
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 0
}

Cancel Fulfillment By ID

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Complete Fulfillment By orderId and fulfillmentId

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Open Fulfillment By orderId and fulfillmentId

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Retrieve a list of all fulfillments for a fulfillment order

path Parameters
fulfillmentOrderId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillments": [
    ]
}

Create a fulfillment for the fulfillment order line items specified

header Parameters
Content-Type
required
string
Request Body schema: application/json
required
object (Fulfillment1)

Responses

Request samples

Content type
application/json
{
  • "fulfillment": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Cancel Fulfillment By fulfillmentId

path Parameters
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Update Tracking info

path Parameters
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
object (Fulfillment)

Responses

Request samples

Content type
application/json
{
  • "fulfillment": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment": {
    }
}

Fulfillment Event

Post Fulfillment Event for a Fulfillment

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (FulfillmentEvent)

Responses

Request samples

Content type
application/json
{
  • "event": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_event": {
    }
}

Get Fulfillment Events for a Fulfillment

path Parameters
orderId
required
string
fulfillmentId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_events": [
    ]
}

Get Fulfillment Event by ID

path Parameters
orderId
required
string
fulfillmentId
required
string
eventId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_event": {
    }
}

Delete Fulfillment Event by ID

path Parameters
orderId
required
string
fulfillmentId
required
string
eventId
required
string
header Parameters
Content-Type
required
string

Responses

Fulfillment Order

Retrieves a list of fulfillment orders for a specific order

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_orders": [
    ]
}

Retrieves a specific fulfillment order

path Parameters
fulfillmentOrderId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_order": {
    }
}

Marks a fulfillment order as cancelled.

path Parameters
fulfillmentOrderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_order": {
    },
  • "replacement_fulfillment_order": {
    }
}

Moves a fulfillment order from one merchant managed location to another merchant managed location.

path Parameters
fulfillmentOrderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "fulfillment_order": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "original_fulfillment_order": {
    },
  • "moved_fulfillment_order": {
    },
  • "remaining_fulfillment_order": {
    }
}

Marks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

path Parameters
fulfillmentOrderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "fulfillment_order": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "fulfillment_order": {
    }
}

Order Transactions

Get Order Transactions

path Parameters
orderId
required
string
query Parameters
in_shop_currency
required
string
since_id
required
string
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "transactions": [
    ]
}

Get Order Transaction By Id

path Parameters
orderId
required
string
transactionId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "transaction": {
    }
}

Create Order Transaction

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Transactions2)

Responses

Request samples

Content type
application/json
{
  • "transaction": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "transaction": {
    }
}

Get Order Transaction Count

path Parameters
orderId
required
string
query Parameters
in_shop_currency
required
string
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 0
}

Delete Metafield for a resource

path Parameters
metafieldId
required
string
objectName
required
string
id
required
string
header Parameters
Content-Type
required
string

Responses

Get CustomCollection count

query Parameters
productId
required
string
title
required
string
published_at_min
required
string
published_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
published_status
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 0
}

Collects Count

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 0
}

Get Countries

query Parameters
since_id
required
string
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "countries": [
    ]
}

Get Shipping Zones

query Parameters
limit
required
string
productId
required
string
fields
required
string
collectionId
required
string
page_info
required
string
since_id
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "shipping_zones": [
    ]
}

Get Shop

query Parameters
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "shop": {
    }
}

Get Countries by ID

path Parameters
countryId
required
string
query Parameters
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "country": {
    }
}

GET Discount codes

path Parameters
priceRuleId
required
string
query Parameters
limit
required
string
page_info
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "discount_codes": [
    ]
}

POST Discount Code

path Parameters
priceRuleId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (DiscountCode3)

Responses

Request samples

Content type
application/json
{
  • "discount_code": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "discount_code": {
    }
}

Delete Discount Code

path Parameters
discountCodeId
required
string

Responses

PUT Discount Code

path Parameters
discountCodeId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (DiscountCode3)

Responses

Request samples

Content type
application/json
{
  • "discount_code": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "discount_code": {
    }
}

GET Discount codes By Code

path Parameters
discountCodeId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "discount_code": {
    }
}

Refunds

Calculate Refund

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Refund)

Responses

Request samples

Content type
application/json
{
  • "refund": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "refund": {
    }
}

Create Refund

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Refund1)

Responses

Request samples

Content type
application/json
{
  • "refund": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "refund": {
    }
}

Get All Refunds for an Order

path Parameters
orderId
required
string
query Parameters
limit
required
string
fields
required
string
in_shop_currency
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "refunds": [
    ]
}

Get Refund By ID

path Parameters
orderId
required
string
refundId
required
string
query Parameters
fields
required
string
limit
required
string
in_shop_currency
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "refund": {
    }
}

Inventory Items

List Inventory Items

query Parameters
ids
required
string
limit
string
page_info
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_items": [
    ]
}

Connect to different location

header Parameters
Content-Type
required
string
Request Body schema: application/json
location_id
integer <int64>
inventory_item_id
integer <int64>
relocate_if_necessary
boolean

Responses

Request samples

Content type
application/json
{
  • "location_id": 0,
  • "inventory_item_id": 0,
  • "relocate_if_necessary": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_level": {
    }
}

Update Inventory Item

path Parameters
inventoryItemId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (InventoryItem1)

Responses

Request samples

Content type
application/json
{
  • "inventory_item": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_item": {
    }
}

Retrieve Inventory Item

path Parameters
inventoryItemId
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_item": {
    }
}

Update Inventory level

header Parameters
Content-Type
required
string
Request Body schema: application/json
location_id
integer <int64>
inventory_item_id
integer <int64>
available_adjustment
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "location_id": 0,
  • "inventory_item_id": 0,
  • "available_adjustment": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_level": {
    }
}

Set the available inventory at a location

header Parameters
Content-Type
required
string
Request Body schema: application/json
location_id
required
integer
inventory_item_id
required
integer
available
required
integer
disconnect_if_necessary
boolean

Responses

Request samples

Content type
application/json
{
  • "location_id": 0,
  • "inventory_item_id": 0,
  • "available": 0,
  • "disconnect_if_necessary": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_level": {
    }
}

Inventory levels

Retrieves a list of Inventory levels

query Parameters
inventory_item_ids
required
string
location_ids
required
string
limit
required
string
updated_at_min
required
string
page_info
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "inventory_levels": [
    ]
}

Remove an inventory item from a location

query Parameters
inventory_item_id
required
string
location_id
required
string

Responses

Collects

List All Collects

query Parameters
limit
required
string
sinceId
required
string
fields
required
string
page_info
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "collects": [
    ]
}

Create Collect

header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Collect1)

Responses

Request samples

Content type
application/json
{
  • "collect": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "collect": {
    }
}

Get Collect by Id

path Parameters
collectId
required
string
query Parameters
limit
required
string
since_id
required
string
fields
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "collect": {
    }
}

Delete Collect

path Parameters
collectId
required
string

Responses

Create Smart Collection

header Parameters
Content-Type
required
string
Request Body schema: application/json
title
string
Array of objects (Rule) [ items ]
published
boolean
object (Image12)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "rules": [
    ],
  • "published": true,
  • "image": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "smart_collection": {
    }
}

Get All Smart Collections

query Parameters
limit
required
string
sinceId
required
string
fields
required
string
productId
required
string
page_info
required
string
id
required
string
title
required
string
handle
required
string
updated_at_min
required
string
updated_at_max
required
string
published_at_min
required
string
published_at_max
required
string
published_status
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "smart_collections": [
    ]
}

Create Custom Collection

header Parameters
Content-Type
required
string
Request Body schema: application/json
object (CustomCollection)

Responses

Request samples

Content type
application/json
{
  • "custom_collection": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "custom_collection": {
    }
}

Get All Custom Collections

query Parameters
limit
required
string
since_id
required
string
fields
required
string
productId
required
string
collectionId
required
string
page_info
required
string
id
required
string
title
required
string
handle
required
string
updated_at_min
required
string
updated_at_max
required
string
published_at_min
required
string
published_at_max
required
string
published_status
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "custom_collections": [
    ]
}

Update Custom Collection

path Parameters
customCollectionId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (CustomCollection)

Responses

Request samples

Content type
application/json
{
  • "custom_collection": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "custom_collection": {
    }
}

Get Custom Collection by ID

path Parameters
customCollectionId
required
string
query Parameters
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "custom_collection": {
    }
}

Delete Custom Collection

path Parameters
customCollectionId
required
string
header Parameters
Content-Type
required
string

Responses

Update Smart Collection

path Parameters
id
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (SmartCollection)

Responses

Request samples

Content type
application/json
{
  • "smart_collection": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "smart_collection": {
    }
}

Get Smart Collection By ID

path Parameters
id
required
string
query Parameters
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "smart_collection": {
    }
}

Delete Smart Collection

path Parameters
id
required
string
header Parameters
Content-Type
required
string

Responses

Order Risks

Create Order Risk

path Parameters
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Risk1)

Responses

Request samples

Content type
application/json
{
  • "risk": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "risk": {
    }
}

Get Order Risks

path Parameters
orderId
required
string
query Parameters
limit
required
string
page_info
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "risks": [
    ]
}

Get Order Risks By ID

path Parameters
riskId
required
string
orderId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "risk": {
    }
}

Update Order Risk by ID

path Parameters
riskId
required
string
orderId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Risk1)

Responses

Request samples

Content type
application/json
{
  • "risk": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "risk": {
    }
}

Delete Risk By ID

path Parameters
riskId
required
string
orderId
required
string
header Parameters
Content-Type
required
string

Responses

Price Rules

Create Price Rule

header Parameters
Content-Type
required
string
Request Body schema: application/json
allocation_method
string
customer_selection
string
ends_at
string
entitled_collection_ids
Array of integers <int32> [ items <int32 > ]
entitled_country_ids
Array of integers <int32> [ items <int32 > ]
entitled_product_ids
Array of integers <int32> [ items <int32 > ]
entitled_variant_ids
Array of integers <int32> [ items <int32 > ]
id
integer <int32>
once_per_customer
boolean
prerequisite_saved_search_ids
Array of integers <int32> [ items <int32 > ]
object (PrerequisiteShippingPriceRange)
object (PrerequisiteSubtotalRange)
starts_at
string
target_selection
string
target_type
string
title
string
usage_limit
integer <int32>
value
integer <int32>
value_type
string

Responses

Request samples

Content type
application/json
{
  • "allocation_method": "string",
  • "customer_selection": "string",
  • "ends_at": "string",
  • "entitled_collection_ids": [
    ],
  • "entitled_country_ids": [
    ],
  • "entitled_product_ids": [
    ],
  • "entitled_variant_ids": [
    ],
  • "id": 0,
  • "once_per_customer": true,
  • "prerequisite_saved_search_ids": [
    ],
  • "prerequisite_shipping_price_range": {
    },
  • "prerequisite_subtotal_range": {
    },
  • "starts_at": "string",
  • "target_selection": "string",
  • "target_type": "string",
  • "title": "string",
  • "usage_limit": 0,
  • "value": 0,
  • "value_type": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "price_rule": {
    }
}

Get Price Rules

query Parameters
limit
required
string
since_id
required
string
created_at_min
required
string
created_at_max
required
string
updated_at_min
required
string
updated_at_max
required
string
starts_at_min
required
string
starts_at_max
required
string
ends_at_min
required
string
ends_at_max
required
string
times_used
required
string
page_info
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "price_rules": [
    ]
}

Get Price Rules by ID

path Parameters
priceRuleId
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "price_rule": {
    }
}

Delete Price Rule

path Parameters
priceRuleId
required
string
header Parameters
Content-Type
required
string

Responses

Metafields

POST Metafield for a resource

path Parameters
objectName
required
string
id
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Metafields)

Responses

Request samples

Content type
application/json
{
  • "metafield": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "metafield": {
    }
}

GET Metafields for a resource

path Parameters
objectName
required
string
id
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "metafields": [
    ]
}

PUT Metafields for resource

path Parameters
id
required
string
objectName
required
string
metafieldId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Metafield2)

Responses

Request samples

Content type
application/json
{
  • "metafield": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "metafield": {
    }
}

GET Metafields Count

header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 0
}

POST Metafields

header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Metafield)

Responses

Request samples

Content type
application/json
{
  • "metafield": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "metafield": {
    }
}

GET Metafields By ID

path Parameters
metafieldId
required
string
query Parameters
fields
required
string
header Parameters
Content-Type
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "metafield": {
    }
}

PUT Metafields

path Parameters
metafieldId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
object (Metafield2)

Responses

Request samples

Content type
application/json
{
  • "metafield": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "metafield": {
    }
}

DELETE Metafield

path Parameters
metafieldId
required
string
header Parameters
Content-Type
required
string

Responses

Product Variant Metafields

GetProductVariantsMetafields

path Parameters
productId
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "metafields": [
    ]
}

Draft Orders

Get Draft Orders

query Parameters
fields
string
ids
string
limit
string
since_id
string
status
string
updated_at_max
string
updated_at_min
string
page_info
string

Responses

Response samples

Content type
application/json
{
  • "draft_orders": [
    ]
}

CreateDraftOrder

Request Body schema: application/json
required
object (DraftOrders)

Responses

Request samples

Content type
application/json
{
  • "draft_order": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "draft_order": {
    }
}

GetDraftOrderbyId

path Parameters
draft_order_id
required
string
query Parameters
fields
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "draft_order": {
    }
}

UpdateDraftOrder

path Parameters
draft_order_id
required
string
Request Body schema: application/json
required
object (DraftOrders)

Responses

Request samples

Content type
application/json
{
  • "draft_order": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "draft_order": {
    }
}

DeleteDraftOrder

path Parameters
draft_order_id
required
string

Responses

CountDraftOrders

query Parameters
since_id
string
status
string
updated_at_max
string
updated_at_min
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 88
}

SendInvoice

path Parameters
draft_order_id
required
string
Request Body schema: application/json
required
object (DraftOrderInvoice)

Responses

Request samples

Content type
application/json
{
  • "draft_order_invoice": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "draft_order_invoice": null
}

CompleteDraftOrder

path Parameters
draft_order_id
required
string
query Parameters
payment_pending
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "draft_order": {
    }
}