Skip to content

Instantly share code, notes, and snippets.

@kinlane

kinlane/shopify-openapi.json

Created August 12, 2018 05:30
Show Gist options
  • Save kinlane/0346107813e6402ba7aaf9e1829616b7 to your computer and use it in GitHub Desktop.
Save kinlane/0346107813e6402ba7aaf9e1829616b7 to your computer and use it in GitHub Desktop.
Download ZIP
shopify openapi
Raw
shopify-openapi.json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Shopify API",
"description": "TODO: Add Description"
},
"host": "DefaultParameterValue:DefaultParameterValue@DefaultParameterValue.myshopify.com",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/admin/custom_collections.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customcollection#index",
"summary": "Get a list of all custom collections",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollectionsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/custom_collections.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all custom collections",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/customcollection#create",
"summary": "Create a new custom collection",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollectionsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCustomCollectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/custom_collections.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"custom_collection\":{\"title\":\"Macbooks\",\"image\":{\"src\":\"http://example.com/rails_logo.gif\"}}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new custom collection",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/script_tags/373484.json": {
"get": {
"description": "https://help.shopify.com/api/reference/scripttag#index",
"summary": "Get a single script tag",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTags373484JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/script_tags/373484.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single script tag",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470.json": {
"put": {
"description": "https://help.shopify.com/api/reference/comment#update",
"summary": "Update a comment",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACommentrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/comments/2941387470.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"comment\":{\"id\":2941387470,\"body\":\"You can even update through a web service.\",\"author\":\"Your new name\",\"email\":\"your@updated-email.com\",\"published_at\":\"2017-01-05T20:37:21.046Z\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a comment",
"x-testDescription": "https://help.shopify.com/api/reference/comment#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/smart_collections/401912846.json": {
"get": {
"description": "https://help.shopify.com/api/reference/smartcollection#index",
"summary": "Get a single collection",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollections401912846JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/smart_collections/401912846.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single collection",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/smartcollection#update",
"summary": "Update a single collection",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollections401912846JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateASingleCollectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/smart_collections/401912846.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"smart_collection\":{\"id\":482865238,\"body_html\":\"<p>5000 songs in your pocket</p>\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a single collection",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/9579007950.json": {
"put": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Update a product and one of its variants",
"tags": [
"Product"
],
"operationId": "AdminProducts9579007950JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductAndOneOfItsVariantsrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/products/9579007950.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"product\":{\"id\":9579007950,\"title\":\"Updated Product Title\",\"variants\":[{\"id\":25831837123,\"price\":\"2000.00\",\"sku\":\"Updating the Product SKU\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a product and one of its variants",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Remove a product from the shop",
"tags": [
"Product"
],
"operationId": "AdminProducts9579007950JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RemoveAProductFromTheShoprequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/products/9579007950.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"product\":{\"id\":9579007950,\"title\":\"Updated Product Title\",\"variants\":[{\"id\":25831837123,\"price\":\"2000.00\",\"sku\":\"Updating the Product SKU\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a product from the shop",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/refunds/calculate.json": {
"post": {
"description": "https://help.shopify.com/api/reference/refund#index",
"summary": "Calculate a refund for a line item and shipping",
"tags": [
"Refund"
],
"operationId": "AdminOrders4554953422RefundsCalculateJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CalculateARefundForALineItemAndShippingrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/refunds/calculate.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"refund\":{\"shipping\":{\"full_refund\":true},\"refund_line_items\":[{\"line_item_id\":25831837123,\"quantity\":1}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Calculate a refund for a line item and shipping",
"x-testDescription": "https://help.shopify.com/api/reference/refund#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/collects.json": {
"get": {
"description": "https://help.shopify.com/api/reference/collect#index",
"summary": "List all collects",
"tags": [
"Collect"
],
"operationId": "AdminCollectsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/collects.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all collects",
"x-testDescription": "https://help.shopify.com/api/reference/collect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/62581763/articles.json": {
"get": {
"summary": "Get a list of all articles from a certain blog",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763ArticlesJsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs/62581763/articles.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all articles from a certain blog"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"summary": "Create a new article for a blog",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763ArticlesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewArticleForABlogrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/blogs/62581763/articles.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"article\":{\"title\":\"Article test\",\"author\":\"John Smith\",\"tags\":\"This Post, Has Been Tagged\",\"body_html\":\"<h1>I like articles</h1>\\n<p><strong>Yea</strong>, I like posting them through <span class=\\\"caps\\\">REST</span>.</p>\",\"published_at\":\"Thu Mar 24 15:45:47 UTC 2011\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new article for a blog"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/metafields.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get all metafields that belong to a store",
"tags": [
"Metafield"
],
"operationId": "AdminMetafieldsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/metafields.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all metafields that belong to a store",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Create a new metafield for a store.",
"tags": [
"Metafield"
],
"operationId": "AdminMetafieldsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewMetafieldForAStore.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/metafields.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"metafield\":{\"namespace\":\"inventory\",\"key\":\"warehouse\",\"value\":25,\"value_type\":\"integer\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new metafield for a store.",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards/61810574/disable.json": {
"post": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Disable a gift card",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCards61810574DisableJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DisableAGiftCardrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/gift_cards/61810574/disable.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"gift_card\":{\"id\":61810574}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Disable a gift card",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/webhooks/503738446.json": {
"put": {
"description": "https://help.shopify.com/api/reference/webhook#update",
"summary": "Update a Webhook",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooks503738446JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAWebhookrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/webhooks/503738446.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"webhook\":{\"id\":4759306,\"address\":\"http://somewhere-else.com/\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a Webhook",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/webhook#destroy",
"summary": "Delete a Webhook",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooks503738446JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/webhooks/503738446.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a Webhook",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/62581763/articles/196805774.json": {
"get": {
"summary": "Get a single article by its ID and the ID of the parent blog",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763Articles196805774JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs/62581763/articles/196805774.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single article by its ID and the ID of the parent blog"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"summary": "Update an article",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763Articles196805774JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnArticlerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/blogs/62581763/articles/196805774.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"article\":{\"title\":\"oi\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an article"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/metafields/33145232974.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get a single store metafield by ID",
"tags": [
"Metafield"
],
"operationId": "AdminMetafields33145232974JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/metafields/33145232974.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single store metafield by ID",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Update an existing store metafield.",
"tags": [
"Metafield"
],
"operationId": "AdminMetafields33145232974JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnExistingStoreMetafield.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/metafields/33145232974.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"metafield\":{\"id\":721389482,\"value\":\"something new\",\"value_type\":\"string\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an existing store metafield.",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Delete a store metafield",
"tags": [
"Metafield"
],
"operationId": "AdminMetafields33145232974JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/metafields/33145232974.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a store metafield",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/cancel.json": {
"post": {
"description": "https://help.shopify.com/api/reference/order#create",
"summary": "Canceling an Order",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422CancelJsonPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/cancel.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Canceling an Order",
"x-testDescription": "https://help.shopify.com/api/reference/order#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards/61466894.json": {
"get": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Show a specific gift card's details",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCards61466894JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/gift_cards/61466894.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Show a specific gift card's details",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/close.json": {
"post": {
"description": "https://help.shopify.com/api/reference/order#create",
"summary": "Close a processed order",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422CloseJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/close.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Close a processed order",
"x-testDescription": "https://help.shopify.com/api/reference/order#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4602125518/risks.json": {
"get": {
"description": "https://help.shopify.com/api/reference/order_risks",
"summary": "Get all Order Risks for an Order",
"tags": [
"OrderRisks"
],
"operationId": "AdminOrders4602125518RisksJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4602125518/risks.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all Order Risks for an Order",
"x-testDescription": "https://help.shopify.com/api/reference/order_risks"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/order_risks",
"summary": "Add a fraud risk for Proxy detection",
"tags": [
"OrderRisks"
],
"operationId": "AdminOrders4602125518RisksJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddAFraudRiskForProxyDetectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4602125518/risks.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"risk\":{\"message\":\"This order came from an anonymous proxy\",\"recommendation\":\"cancel\",\"score\":1.0,\"source\":\"External\",\"cause_cancel\":true,\"display\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add a fraud risk for Proxy detection",
"x-testDescription": "https://help.shopify.com/api/reference/order_risks"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs.json": {
"get": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Get a list of all blogs",
"tags": [
"Blog"
],
"operationId": "AdminBlogsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all blogs",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Create a new blog",
"tags": [
"Blog"
],
"operationId": "AdminBlogsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewBlogrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/blogs.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"blog\":{\"title\":\"Test Blog via API\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new blog",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/policies.json": {
"get": {
"description": "https://help.shopify.com/api/reference/policy",
"summary": "getting the shops policies",
"tags": [
"Policy"
],
"operationId": "AdminPoliciesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/policies.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "getting the shops policies",
"x-testDescription": "https://help.shopify.com/api/reference/policy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/events.json": {
"get": {
"description": "https://help.shopify.com/api/reference/event#articles",
"summary": "Get all the events from a particular order",
"tags": [
"Event"
],
"operationId": "AdminOrders4554953422EventsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/events.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all the events from a particular order",
"x-testDescription": "https://help.shopify.com/api/reference/event#articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/pages/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/page",
"summary": "Count all pages for a shop",
"tags": [
"Page"
],
"operationId": "AdminPagesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/pages/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Count all pages for a shop",
"x-testDescription": "https://help.shopify.com/api/reference/page"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/transactions/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/transaction#index",
"summary": "Get a count of transactions for an order",
"tags": [
"Transaction"
],
"operationId": "AdminOrders4554953422TransactionsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/transactions/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of transactions for an order",
"x-testDescription": "https://help.shopify.com/api/reference/transaction#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Retrieve a count of all gift cards",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCardsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/gift_cards/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieve a count of all gift cards",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries.json": {
"get": {
"description": "https://help.shopify.com/api/reference/country#index",
"summary": "Get a list of all countries",
"tags": [
"Country"
],
"operationId": "AdminCountriesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all countries",
"x-testDescription": "https://help.shopify.com/api/reference/country#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/country#index",
"summary": "Create a country",
"tags": [
"Country"
],
"operationId": "AdminCountriesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACountryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/countries.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"country\":{\"code\":\"FR\",\"tax\":0.25}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a country",
"x-testDescription": "https://help.shopify.com/api/reference/country#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/fulfillment_services.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillmentservice",
"summary": "List your app's fulfillment services",
"tags": [
"FullfilmentService"
],
"operationId": "AdminFulfillmentServicesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/fulfillment_services.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List your app's fulfillment services",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentservice"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/fulfillmentservice",
"summary": "Create a fulfillment service",
"tags": [
"FullfilmentService"
],
"operationId": "AdminFulfillmentServicesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAFulfillmentServicerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/fulfillment_services.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"fulfillment_service\":{\"name\":\"MarsFulfillment\",\"callback_url\":\"http://google.com\",\"inventory_management\":true,\"tracking_support\":true,\"requires_shipping_method\":true,\"format\":\"json\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a fulfillment service",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentservice"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/pages/216307854.json": {
"put": {
"description": "https://help.shopify.com/api/reference/page#update",
"summary": "update a page",
"tags": [
"Page"
],
"operationId": "AdminPages216307854JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAPagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/pages/216307854.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"page\":{\"id\":131092082,\"published\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "update a page",
"x-testDescription": "https://help.shopify.com/api/reference/page#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/page#update",
"summary": "Delete a page",
"tags": [
"Page"
],
"operationId": "AdminPages216307854JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAPagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/pages/216307854.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"page\":{\"id\":131092082,\"published\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a page",
"x-testDescription": "https://help.shopify.com/api/reference/page#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651/addresses/5484465742.json": {
"put": {
"description": "https://help.shopify.com/api/reference/customeraddress#update",
"summary": "Updating a customers postal code",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651Addresses5484465742JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdatingACustomersPostalCoderequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/customers/3989659651/addresses/5484465742.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"address\":{\"id\":207119551,\"zip\":\"90210\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Updating a customers postal code",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/customeraddress#destroy",
"summary": "Removing a customers address",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651Addresses5484465742JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/customers/3989659651/addresses/5484465742.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Removing a customers address",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/search.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customer#index",
"summary": "Get all customers with an address in the Brazil",
"tags": [
"Customer"
],
"operationId": "AdminCustomersSearchJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers/search.json?query=country:Brazil",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all customers with an address in the Brazil",
"x-testDescription": "https://help.shopify.com/api/reference/customer#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/application_charges.json": {
"get": {
"summary": "Retrieving all one-time charges since a specified ID",
"tags": [
"ApplicationCharge"
],
"operationId": "AdminApplicationChargesJsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "since_id",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/application_charges.json?since_id=556467234",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieving all one-time charges since a specified ID"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"summary": "Create a new one-time application charge.",
"tags": [
"ApplicationCharge"
],
"operationId": "AdminApplicationChargesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Create a new oneTime application charge.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/application_charges.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"application_charge\":{\"name\":\"Super Duper Expensive action\",\"price\":100.0,\"return_url\":\"http://super-duper.shopifyapps.com\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new one-time application charge."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/62581763/articles/count.json": {
"get": {
"summary": "Get a count of all articles from a certain blog",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763ArticlesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs/62581763/articles/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all articles from a certain blog"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/metafields/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get a count of all metafields for a store",
"tags": [
"Metafield"
],
"operationId": "AdminMetafieldsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/metafields/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all metafields for a store",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/custom_collections/246409795.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customcollection#index",
"summary": "Get a single custom collections",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollections246409795JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/custom_collections/246409795.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single custom collections",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/customcollection#index",
"summary": "update a custom collection",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollections246409795JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACustomCollectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/custom_collections/246409795.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"custom_collection\":{\"id\":841564295,\"body_html\":\"<p>5000 songs in your pocket</p>\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "update a custom collection",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/customcollection#destroy",
"summary": "delete a custom collection",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollections246409795JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/custom_collections/246409795.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "delete a custom collection",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"//admin/comments.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "Create a new comment for an article",
"tags": [
"comments"
],
"operationId": "AdminCommentsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCommentForAnArticlerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "//admin/comments.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"comment\":{\"body\":\"I like comments\\nAnd I like posting them *RESTfully*.\",\"author\":\"Your name\",\"email\":\"renato@basico.com\",\"ip\":\"107.20.160.121\",\"blog_id\":62581763,\"article_id\":128701187}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new comment for an article",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651/addresses.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get all of a customer's addresses",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651AddressesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers/3989659651/addresses.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all of a customer's addresses",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/customeraddress#create",
"summary": "Creating a new address for a customer",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651AddressesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreatingANewAddressForACustomerrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/customers/3989659651/addresses.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"address\":{\"address1\":\"1 Rue des Carrieres\",\"address2\":\"Suite 1234\",\"city\":\"Montreal\",\"company\":\"Fancy Co.\",\"first_name\":\"Samuel\",\"last_name\":\"de Champlain\",\"phone\":\"819-555-5555\",\"province\":\"Quebec\",\"country\":\"Canada\",\"zip\":\"G1R 4P5\",\"name\":\"Samuel de Champlain\",\"province_code\":\"QC\",\"country_code\":\"CA\",\"country_name\":\"Canada\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Creating a new address for a customer",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/#{id}.json": {
"get": {
"description": "https://help.shopify.com/api/reference/comment#index",
"summary": "Get a single comment",
"tags": [
"comments"
],
"operationId": "AdminCommentsAPIJsonByIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards.json": {
"get": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Get a list of all gift cards",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCardsJsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/gift_cards.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all gift cards",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Create a new gift card with an automatically generated code",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCardsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewGiftCardWithAnAutomaticallyGeneratedCoderequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/gift_cards.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"gift_card\":{\"initial_value\":25.0}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new gift card with an automatically generated code",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/articles/tags.json": {
"get": {
"summary": "Get a list of all the tags of articles",
"tags": [
"Article"
],
"operationId": "AdminArticlesTagsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/articles/tags.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all the tags of articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4602125518/risks/8609858574.json": {
"get": {
"description": "https://help.shopify.com/api/reference/order_risks",
"summary": "Get a single Order Risk",
"tags": [
"OrderRisks"
],
"operationId": "AdminOrders4602125518Risks8609858574JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4602125518/risks/8609858574.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single Order Risk",
"x-testDescription": "https://help.shopify.com/api/reference/order_risks"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/order_risks",
"summary": "Update an existing risk detail line on an order",
"tags": [
"OrderRisks"
],
"operationId": "AdminOrders4602125518Risks8609858574JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnExistingRiskDetailLineOnAnOrderrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/orders/4602125518/risks/8609858574.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"risk\":{\"id\":284138680,\"message\":\"After further review, this is a legitimate order\",\"recommendation\":\"accept\",\"source\":\"External\",\"cause_cancel\":false,\"score\":0.0}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an existing risk detail line on an order",
"x-testDescription": "https://help.shopify.com/api/reference/order_risks"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/order_risks",
"summary": "Delete an erroneous risk entry",
"tags": [
"OrderRisks"
],
"operationId": "AdminOrders4602125518Risks8609858574JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAnErroneousRiskEntryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/orders/4602125518/risks/8609858574.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"risk\":{\"id\":284138680,\"message\":\"After further review, this is a legitimate order\",\"recommendation\":\"accept\",\"source\":\"External\",\"cause_cancel\":false,\"score\":0.0}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an erroneous risk entry",
"x-testDescription": "https://help.shopify.com/api/reference/order_risks"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4495703502/fulfillments.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Get a list of all fulfillments for an order.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4495703502FulfillmentsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4495703502/fulfillments.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all fulfillments for an order.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/variants/34705478094.json": {
"put": {
"description": "https://help.shopify.com/api/reference/product_variant#update",
"summary": "Update an existing product variant",
"tags": [
"ProductVariant"
],
"operationId": "AdminVariants34705478094JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnExistingProductVariantrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/variants/34705478094.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"variant\":{\"id\":808950810,\"option1\":\"Not Pink\",\"price\":\"99.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an existing product variant",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customer_saved_searches/1189248515/customers.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get all customers who match the criteria",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearches1189248515CustomersJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customer_saved_searches/1189248515/customers.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all customers who match the criteria",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/refunds.json": {
"get": {
"description": "https://help.shopify.com/api/reference/refund#index",
"summary": "Get all refunds from a specific order",
"tags": [
"Refund"
],
"operationId": "AdminOrders4554953422RefundsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/refunds.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all refunds from a specific order",
"x-testDescription": "https://help.shopify.com/api/reference/refund#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/refund#index",
"summary": "Create a new refund for an order",
"tags": [
"Refund"
],
"operationId": "AdminOrders4554953422RefundsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewRefundForAnOrderrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/refunds.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"refund\":{\"restock\":true,\"notify\":true,\"note\":\"wrong size\",\"shipping\":{\"full_refund\":true},\"refund_line_items\":[{\"line_item_id\":518995019,\"quantity\":1}],\"transactions\":[{\"parent_id\":801038806,\"amount\":199.65,\"kind\":\"refund\",\"gateway\":\"bogus\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new refund for an order",
"x-testDescription": "https://help.shopify.com/api/reference/refund#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678/cancel.json": {
"post": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Cancel a fulfillment.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678CancelJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4528049998/fulfillments/3770145678/cancel.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Cancel a fulfillment.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422.json": {
"get": {
"description": "https://help.shopify.com/api/reference/order#index",
"summary": "Get a representation of a single order",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a representation of a single order",
"x-testDescription": "https://help.shopify.com/api/reference/order#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/order#index",
"summary": "Update an order",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnOrderrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/orders/4554953422.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"order\":{\"customer\":\"null\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an order",
"x-testDescription": "https://help.shopify.com/api/reference/order#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/order#index",
"summary": "Delete an order.",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAnOrder.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/orders/4554953422.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"order\":{\"customer\":\"null\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an order.",
"x-testDescription": "https://help.shopify.com/api/reference/order#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/open.json": {
"post": {
"description": "https://help.shopify.com/api/reference/order#create",
"summary": "Re-opening a closed Order",
"tags": [
"Order"
],
"operationId": "AdminOrders4554953422OpenJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/open.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Re-opening a closed Order",
"x-testDescription": "https://help.shopify.com/api/reference/order#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678/complete.json": {
"post": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Complete a fulfillment.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678CompleteJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4528049998/fulfillments/3770145678/complete.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Complete a fulfillment.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/smart_collections.json": {
"get": {
"description": "https://help.shopify.com/api/reference/smartcollection#index",
"summary": "Get all collection",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollectionsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/smart_collections.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all collection",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/smartcollection#create",
"summary": "Create a new collection",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollectionsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCollectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/smart_collections.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"smart_collection\":{\"title\":\"Macbooks\",\"published\":false}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new collection",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4495703502/fulfillments/3763917198/events/9519874062.json": {
"delete": {
"description": "https://help.shopify.com/api/reference/fulfillmentevent#index",
"summary": "Delete a fulfillment event.",
"tags": [
"FullfilmentEvent"
],
"operationId": "AdminOrders4495703502Fulfillments3763917198Events9519874062JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAFulfillmentEvent.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/orders/4495703502/fulfillments/3763917198/events/9519874062.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"event\":{\"status\":\"delivered\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a fulfillment event.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentevent#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/events/58706658318.json": {
"get": {
"description": "https://help.shopify.com/api/reference/event#articles",
"summary": "Shows the same fields as the list action.",
"tags": [
"Event"
],
"operationId": "AdminEvents58706658318JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/events/58706658318.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Shows the same fields as the list action.",
"x-testDescription": "https://help.shopify.com/api/reference/event#articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/locations/8790723.json": {
"get": {
"description": "https://help.shopify.com/api/reference/location",
"summary": "Get a single location",
"tags": [
"Location"
],
"operationId": "AdminLocations8790723JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/locations/8790723.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single location",
"x-testDescription": "https://help.shopify.com/api/reference/location"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/images.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Get all product images",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555ImagesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/images.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all product images",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Create a new product image",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555ImagesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductImagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/products/7990943555/images.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"image\":{\"src\":\"http://example.com/rails_logo.gif\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new product image",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/webhooks.json": {
"get": {
"description": "https://help.shopify.com/api/reference/webhook#index",
"summary": "Get a list of all webhooks for your shop.",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooksJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/webhooks.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all webhooks for your shop.",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/webhook#create",
"summary": "Create a webhook",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooksJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAWebhookrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/webhooks.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"webhook\":{\"topic\":\"orders/create\",\"address\":\"http://whatever.hostname.com/\",\"format\":\"json\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a webhook",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/metafields/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get a count of all metafields that belong to a product",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555MetafieldsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/metafields/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all metafields that belong to a product",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customer#index",
"summary": "Get all orders from a customer",
"tags": [
"Customer"
],
"operationId": "AdminOrdersJsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "customer_id",
"in": "query",
"required": true,
"type": "number",
"format": "double",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders.json?customer_id=5380614542",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all orders from a customer",
"x-testDescription": "https://help.shopify.com/api/reference/customer#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/order#create",
"summary": "Create a pending order with an existing customer",
"tags": [
"Order"
],
"operationId": "AdminOrdersJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAPendingOrderWithAnExistingCustomerrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"order\":{\"line_items\":[{\"variant_id\":33214924878,\"quantity\":1}],\"customer\":{\"id\":3989659651},\"financial_status\":\"pending\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a pending order with an existing customer",
"x-testDescription": "https://help.shopify.com/api/reference/order#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/webhooks/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/webhook#index",
"summary": "Get a count of all webhooks for your shop.",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooksCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/webhooks/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all webhooks for your shop.",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/444574734.json": {
"put": {
"description": "https://help.shopify.com/api/reference/country#update",
"summary": "update a country",
"tags": [
"Country"
],
"operationId": "AdminCountries444574734JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACountryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/countries/444574734.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"country\":{\"id\":444574734,\"tax\":0.1}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "update a country",
"x-testDescription": "https://help.shopify.com/api/reference/country#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/country#destroy",
"summary": "delete a country",
"tags": [
"Country"
],
"operationId": "AdminCountries444574734JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/countries/444574734.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "delete a country",
"x-testDescription": "https://help.shopify.com/api/reference/country#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/carrier_services.json": {
"get": {
"description": "https://help.shopify.com/api/reference/carrierservice#index",
"summary": "List carrier services",
"tags": [
"CarrierService"
],
"operationId": "AdminCarrierServicesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/carrier_services.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List carrier services",
"x-testDescription": "https://help.shopify.com/api/reference/carrierservice#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/carrierservice#create",
"summary": "Create a carrier service",
"tags": [
"CarrierService"
],
"operationId": "AdminCarrierServicesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACarrierServicerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/carrier_services.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"carrier_service\":{\"name\":\"Shipping Rate Provider\",\"callback_url\":\"http://shippingrateprovider.com\",\"service_discovery\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a carrier service",
"x-testDescription": "https://help.shopify.com/api/reference/carrierservice#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/collects/20713233987.json": {
"get": {
"description": "https://help.shopify.com/api/reference/collect#index",
"summary": "Return a collect with a certain id",
"tags": [
"Collect"
],
"operationId": "AdminCollects20713233987JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/collects/20713233987.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Return a collect with a certain id",
"x-testDescription": "https://help.shopify.com/api/reference/collect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/discounts/2951196163.json": {
"get": {
"description": "https://help.shopify.com/api/reference/discount#index",
"summary": "Retrieve a discount",
"tags": [
"Discount"
],
"operationId": "AdminDiscounts2951196163JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/discounts/2951196163.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieve a discount",
"x-testDescription": "https://help.shopify.com/api/reference/discount#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/discount#destroy",
"summary": "Delete a discount",
"tags": [
"Discount"
],
"operationId": "AdminDiscounts2951196163JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteADiscountrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/discounts/2951196163.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"discount\":{\"discount_type\":\"fixed_amount\",\"value\":\"10.00\",\"code\":\"fortunamajor\",\"minimum_order_amount\":\"40.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a discount",
"x-testDescription": "https://help.shopify.com/api/reference/discount#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/fulfillment_services/1357646.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillmentservice",
"summary": "Get a single fulfillment service by its ID",
"tags": [
"FullfilmentService"
],
"operationId": "AdminFulfillmentServices1357646JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/fulfillment_services/1357646.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single fulfillment service by its ID",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentservice"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/fulfillmentservice",
"summary": "Update a fulfillment service",
"tags": [
"FullfilmentService"
],
"operationId": "AdminFulfillmentServices1357646JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAFulfillmentServicerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/fulfillment_services/1357646.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"fulfillment_service\":{\"id\":755357713,\"inventory_management\":false}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a fulfillment service",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentservice"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/fulfillmentservice",
"summary": "Destroy a fulfillment service",
"tags": [
"FullfilmentService"
],
"operationId": "AdminFulfillmentServices1357646JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DestroyAFulfillmentServicerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/fulfillment_services/1357646.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"fulfillment_service\":{\"id\":755357713,\"inventory_management\":false}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Destroy a fulfillment service",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentservice"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651/addresses/5436816654/default.json": {
"put": {
"description": "https://help.shopify.com/api/reference/customeraddress#update",
"summary": "assigning a new default address to a customer",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651Addresses5436816654DefaultJsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/customers/3989659651/addresses/5436816654/default.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "assigning a new default address to a customer",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/variants/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_variant#index",
"summary": "Get a count of variants for a product",
"tags": [
"ProductVariant"
],
"operationId": "AdminProducts7990943555VariantsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/variants/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of variants for a product",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/pages.json": {
"get": {
"description": "https://help.shopify.com/api/reference/page",
"summary": "Get a list of all pages",
"tags": [
"Page"
],
"operationId": "AdminPagesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/pages.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all pages",
"x-testDescription": "https://help.shopify.com/api/reference/page"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/page#create",
"summary": "Create a new page",
"tags": [
"Page"
],
"operationId": "AdminPagesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewPagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/pages.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"page\":{\"title\":\"Warranty information\",\"body_html\":\"<h1>Warranty</h1>\\n<p><strong>Forget it</strong>, we aint giving you nothing</p>\",\"published\":false}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new page",
"x-testDescription": "https://help.shopify.com/api/reference/page#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470/spam.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "Mark a comment as Spam",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470SpamJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/comments/2941387470/spam.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Mark a comment as Spam",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651/addresses/set.json": {
"put": {
"description": "https://help.shopify.com/api/reference/customeraddress#update",
"summary": "destroying multiple customer addresses",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651AddressesSetJsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "address_ids[]",
"in": "query",
"required": true,
"type": "number",
"format": "double",
"description": ""
},
{
"name": "operation",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/customers/3989659651/addresses/set.json?address_ids[]=5441388622&operation=destroy",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "destroying multiple customer addresses",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin//variants/25831837123.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_variant#index",
"summary": "Get a product variant by id",
"tags": [
"ProductVariant"
],
"operationId": "AdminVariants25831837123JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin//variants/25831837123.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a product variant by id",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/themes/110163843/assets.json": {
"get": {
"description": "https://help.shopify.com/api/reference/asset#index",
"summary": "Get a list of all theme assets",
"tags": [
"Asset"
],
"operationId": "AdminThemes110163843AssetsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/themes/110163843/assets.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all theme assets",
"x-testDescription": "https://help.shopify.com/api/reference/asset#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/asset#update",
"summary": "Change an existing liquid template's value",
"tags": [
"Asset"
],
"operationId": "AdminThemes110163843AssetsJsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ChangeAnExistingLiquidTemplate'sValuerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/themes/110163843/assets.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"asset\":{\"key\":\"templates/index.liquid\",\"value\":\"<img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Change an existing liquid template's value",
"x-testDescription": "https://help.shopify.com/api/reference/asset#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/asset#destroy",
"summary": "Remove assets from your shop",
"tags": [
"Asset"
],
"operationId": "AdminThemes110163843AssetsJsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/themes/110163843/assets.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove assets from your shop",
"x-testDescription": "https://help.shopify.com/api/reference/asset#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/redirects/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/redirect#index",
"summary": "Get a countt of all URL redirect",
"tags": [
"Redirect"
],
"operationId": "AdminRedirectsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/redirects/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a countt of all URL redirect",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/account/login": {
"post": {
"description": "There is no documentation for that, its a Hack.",
"summary": "Hack Authentication",
"operationId": "AccountLoginPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "customer[email]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customer[{{password}}]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/account/login",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
"body": "customer[email]=fulano@basico.com&customer[{{password}}]=101010"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Hack Authentication",
"x-testDescription": "There is no documentation for that, its a Hack."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments.json": {
"get": {
"description": "https://help.shopify.com/api/reference/comment#index",
"summary": "Get a list of all comments",
"tags": [
"comments"
],
"operationId": "AdminCommentsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/comments.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all comments",
"x-testDescription": "https://help.shopify.com/api/reference/comment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/images/19489404942.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Get a single product image by id",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555Images19489404942JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/images/19489404942.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single product image by id",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Modify an existing product image",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555Images19489404942JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ModifyAnExistingProductImagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/products/7990943555/images/19489404942.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"image\":{\"id\":850703190,\"position\":2,\"metafields\":[{\"key\":\"alt\",\"value\":\"new alt tag content\",\"value_type\":\"string\",\"namespace\":\"tags\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Modify an existing product image",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Delete a product image",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555Images19489404942JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAProductImagerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/products/7990943555/images/19489404942.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"image\":{\"id\":850703190,\"position\":2,\"metafields\":[{\"key\":\"alt\",\"value\":\"new alt tag content\",\"value_type\":\"string\",\"namespace\":\"tags\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product image",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470/remove.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "Remove a comment",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470RemoveJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/comments/2941387470/remove.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a comment",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/261414723/provinces/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/province#index\n",
"summary": "Get a count of all provinces",
"tags": [
"Province"
],
"operationId": "AdminCountries261414723ProvincesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries/261414723/provinces/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all provinces",
"x-testDescription": "https://help.shopify.com/api/reference/province#index\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/variants.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_variant#index",
"summary": "Get all variants for a product",
"tags": [
"ProductVariant"
],
"operationId": "AdminProducts7990943555VariantsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/variants.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all variants for a product",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/product_variant#create",
"summary": "Create a new product variant",
"tags": [
"ProductVariant"
],
"operationId": "AdminProducts7990943555VariantsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductVariantrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/products/7990943555/variants.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"variant\":{\"option1\":\"Yellow\",\"price\":\"1.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new product variant",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/themes/110163843.json": {
"get": {
"description": "https://help.shopify.com/api/reference/theme#index",
"summary": "Get a single theme",
"tags": [
"Theme"
],
"operationId": "AdminThemes110163843JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/themes/110163843.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single theme",
"x-testDescription": "https://help.shopify.com/api/reference/theme#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/5438892686.json": {
"put": {
"description": "https://help.shopify.com/api/reference/customer#update",
"summary": "Add metafield to an existing customer",
"tags": [
"Customer"
],
"operationId": "AdminCustomers5438892686JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddMetafieldToAnExistingCustomerrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/customers/5438892686.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"customer\":{\"id\":207119551,\"metafields\":[{\"key\":\"new\",\"value\":\"newvalue\",\"value_type\":\"string\",\"namespace\":\"global\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add metafield to an existing customer",
"x-testDescription": "https://help.shopify.com/api/reference/customer#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/customer#destroy",
"summary": "Remove an existing customer",
"tags": [
"Customer"
],
"operationId": "AdminCustomers5438892686JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/customers/5438892686.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove an existing customer",
"x-testDescription": "https://help.shopify.com/api/reference/customer#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customer_saved_searches/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get a count of all customer saved searches",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearchesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customer_saved_searches/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all customer saved searches",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards/61810574.json": {
"put": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Update the expiry date of a gift card",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCards61810574JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateTheExpiryDateOfAGiftCardrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/gift_cards/61810574.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"gift_card\":{\"expires_on\":\"2020-01-01\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update the expiry date of a gift card",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/discounts.json": {
"get": {
"description": "https://help.shopify.com/api/reference/discount#index",
"summary": "List all discounts",
"tags": [
"Discount"
],
"operationId": "AdminDiscountsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/discounts.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all discounts",
"x-testDescription": "https://help.shopify.com/api/reference/discount#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/discount#create",
"summary": "Create a discount",
"tags": [
"Discount"
],
"operationId": "AdminDiscountsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateADiscountrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/discounts.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"discount\":{\"discount_type\":\"fixed_amount\",\"value\":\"10.00\",\"code\":\"fortunamajor\",\"minimum_order_amount\":\"40.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a discount",
"x-testDescription": "https://help.shopify.com/api/reference/discount#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Get the Representation of a specific fulfillment.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4528049998/fulfillments/3770145678.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get the Representation of a specific fulfillment.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Update tracking number for a fulfillment.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateTrackingNumberForAFulfillment.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/orders/4528049998/fulfillments/3770145678.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"fulfillment\":{\"tracking_number\":\"987654321\",\"id\":3770145678}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update tracking number for a fulfillment.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/92408974.json": {
"put": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Update a blog",
"tags": [
"Blog"
],
"operationId": "AdminBlogs92408974JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateABlogrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/blogs/92408974.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"blog\":{\"metafields\":[{\"key\":\"new\",\"value\":\"newvalue\",\"value_type\":\"string\",\"namespace\":\"global\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a blog",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Delete a blog",
"tags": [
"Blog"
],
"operationId": "AdminBlogs92408974JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/blogs/92408974.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a blog",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/locations.json": {
"get": {
"description": "https://help.shopify.com/api/reference/location",
"summary": "Get a list of all locations for a shop",
"tags": [
"Location"
],
"operationId": "AdminLocationsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/locations.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all locations for a shop",
"x-testDescription": "https://help.shopify.com/api/reference/location"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678/events/#{event_id}.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillmentevent#index",
"summary": "Fetch a fulfillment event.",
"tags": [
"FullfilmentEvent"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678EventsAPIJsonByEventIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/carrier_services/13841038.json": {
"get": {
"description": "https://help.shopify.com/api/reference/carrierservice#update",
"summary": "Update a carrier service",
"tags": [
"CarrierService"
],
"operationId": "AdminCarrierServices13841038JsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/carrier_services/13841038.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a carrier service",
"x-testDescription": "https://help.shopify.com/api/reference/carrierservice#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/carrierservice#destroy",
"summary": "Destroy a carrier service",
"tags": [
"CarrierService"
],
"operationId": "AdminCarrierServices13841038JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DestroyACarrierServicerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/carrier_services/13841038.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"carrier_service\":{\"name\":\"Shipping Rate Provider\",\"callback_url\":\"http://shippingrateprovider.com\",\"service_discovery\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Destroy a carrier service",
"x-testDescription": "https://help.shopify.com/api/reference/carrierservice#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/transactions.json": {
"get": {
"description": "https://help.shopify.com/api/reference/transaction#index",
"summary": "Get all transactions for an order",
"tags": [
"Transaction"
],
"operationId": "AdminOrders4554953422TransactionsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/transactions.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all transactions for an order",
"x-testDescription": "https://help.shopify.com/api/reference/transaction#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/transaction#create",
"summary": "Capture a previously authorized order for the full amount",
"tags": [
"Transaction"
],
"operationId": "AdminOrders4554953422TransactionsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CaptureAPreviouslyAuthorizedOrderForTheFullAmountrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4554953422/transactions.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"transaction\":{\"kind\":\"capture\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Capture a previously authorized order for the full amount",
"x-testDescription": "https://help.shopify.com/api/reference/transaction#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678/open.json": {
"post": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Transition a fulfillment from pending to open.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678OpenJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "object"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4528049998/fulfillments/3770145678/open.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Transition a fulfillment from pending to open.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/62581763/articles/197247246.json": {
"delete": {
"description": "https://help.shopify.com/api/reference/article#destroy",
"summary": "Delete an article of a blog tags of articles",
"tags": [
"Article"
],
"operationId": "AdminBlogs62581763Articles197247246JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/blogs/62581763/articles/197247246.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an article of a blog tags of articles",
"x-testDescription": "https://help.shopify.com/api/reference/article#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470/approve.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "Approve a comment",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470ApproveJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/comments/2941387470/approve.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Approve a comment",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/checkouts.json": {
"get": {
"summary": "List all abandoned checkouts",
"tags": [
"Abandoned Checkout"
],
"operationId": "AdminCheckoutsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/checkouts.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all abandoned checkouts"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/redirects/293743566.json": {
"put": {
"description": "https://help.shopify.com/api/reference/redirect#update",
"summary": "Update a redirect",
"tags": [
"Redirect"
],
"operationId": "AdminRedirects293743566JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateARedirectrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/redirects/293743566.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"redirect\":{\"id\":668809255,\"path\":\"/tiger\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a redirect",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/redirect#destroy",
"summary": "delete a redirect",
"tags": [
"Redirect"
],
"operationId": "AdminRedirects293743566JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/redirects/293743566.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "delete a redirect",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/gift_cards/search.json": {
"get": {
"description": "https://help.shopify.com/api/reference/gift_card",
"summary": "Get all gift cards that matches the query",
"tags": [
"GiftCards"
],
"operationId": "AdminGiftCardsSearchJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/gift_cards/search.json?query=61",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all gift cards that matches the query",
"x-testDescription": "https://help.shopify.com/api/reference/gift_card"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customer_saved_searches.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get all customer saved searches for a shop",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearchesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customer_saved_searches.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all customer saved searches for a shop",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/customeraddress#create",
"summary": "Create a new Customer Saved Search",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearchesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCustomerSavedSearchrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/customer_saved_searches.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"customer_saved_search\":{\"name\":\"Spent more than $50\",\"query\":\"total_spent:>50\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new Customer Saved Search",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customer#index",
"summary": "Get a single customer by ID",
"tags": [
"Customer"
],
"operationId": "AdminCustomers3989659651JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers/3989659651.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single customer by ID",
"x-testDescription": "https://help.shopify.com/api/reference/customer#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Count all products",
"tags": [
"Product"
],
"operationId": "AdminProductsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Count all products",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/redirects.json": {
"get": {
"description": "https://help.shopify.com/api/reference/redirect#index",
"summary": "Get a list of all URL redirect",
"tags": [
"Redirect"
],
"operationId": "AdminRedirectsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/redirects.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all URL redirect",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/redirect#create",
"summary": "Create a new redirect.",
"tags": [
"Redirect"
],
"operationId": "AdminRedirectsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewRedirect.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/redirects.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"redirect\":{\"path\":\"/ipod\",\"target\":\"/pages/itunes\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new redirect.",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/order#index",
"summary": "Count all orders",
"tags": [
"Order"
],
"operationId": "AdminOrdersCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Count all orders",
"x-testDescription": "https://help.shopify.com/api/reference/order#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/collects/921728736.json": {
"delete": {
"description": "https://help.shopify.com/api/reference/collect#delete",
"summary": "Remove a product from a collection",
"tags": [
"Collect"
],
"operationId": "AdminCollects921728736JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/collects/921728736.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a product from a collection",
"x-testDescription": "https://help.shopify.com/api/reference/collect#delete"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/3770145678/events.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillmentevent#index",
"summary": "Get a list of all fulfillment events for a fulfillment",
"tags": [
"FullfilmentEvent"
],
"operationId": "AdminOrders4528049998Fulfillments3770145678EventsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4528049998/fulfillments/3770145678/events.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all fulfillment events for a fulfillment",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentevent#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470/not_spam.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "Mark a comment as not spam",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470NotSpamJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/comments/2941387470/not_spam.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Mark a comment as not spam",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/images/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product_image#index",
"summary": "Get a count of all product images",
"tags": [
"ProductImage"
],
"operationId": "AdminProducts7990943555ImagesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/images/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all product images",
"x-testDescription": "https://help.shopify.com/api/reference/product_image#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/script_tags.json": {
"get": {
"description": "https://help.shopify.com/api/reference/scripttag#index",
"summary": "Get a list of all script tags",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTagsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/script_tags.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all script tags",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/scripttag#create",
"summary": "create a new script tag",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTagsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewScriptTagrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/script_tags.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"script_tag\":{\"event\":\"onload\",\"src\":\"https://djavaskripped.org/fancy.js\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "create a new script tag",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4495703502/fulfillments/3763917198/events.json": {
"post": {
"description": "https://help.shopify.com/api/reference/fulfillmentevent#index",
"summary": "Create a fulfillment event.",
"tags": [
"FullfilmentEvent"
],
"operationId": "AdminOrders4495703502Fulfillments3763917198EventsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAFulfillmentEvent.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/orders/4495703502/fulfillments/3763917198/events.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"event\":{\"status\":\"delivered\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a fulfillment event.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillmentevent#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customer#index",
"summary": "Get a count of all customers",
"tags": [
"Customer"
],
"operationId": "AdminCustomersCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all customers",
"x-testDescription": "https://help.shopify.com/api/reference/customer#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/transactions/5016037966.json": {
"get": {
"description": "https://help.shopify.com/api/reference/transaction#index",
"summary": "Get a specific transaction",
"tags": [
"Transaction"
],
"operationId": "AdminOrders4554953422Transactions5016037966JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/transactions/5016037966.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a specific transaction",
"x-testDescription": "https://help.shopify.com/api/reference/transaction#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/application_charges/1.json": {
"get": {
"summary": "Retrieve one-time application charge",
"tags": [
"ApplicationCharge"
],
"operationId": "AdminApplicationCharges1JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/application_charges/1.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieve one-time application charge"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4528049998/fulfillments/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/fulfillment#index",
"summary": "Count all the total number of fulfillments for an order.",
"tags": [
"Fullfilment"
],
"operationId": "AdminOrders4528049998FulfillmentsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4528049998/fulfillments/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Count all the total number of fulfillments for an order.",
"x-testDescription": "https://help.shopify.com/api/reference/fulfillment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/application_charges/675931192/activate.json": {
"post": {
"summary": "Activate a one-time charge",
"tags": [
"ApplicationCharge"
],
"operationId": "AdminApplicationCharges675931192ActivateJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Activate a oneTime chargerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/application_charges/675931192/activate.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"application_charge\":{\"id\":675931192,\"name\":\"iPod Cleaning\",\"api_client_id\":755357713,\"price\":\"5.00\",\"status\":\"accepted\",\"return_url\":\"http://google.com\",\"created_at\":\"\\\"2017-01-05T20:31:41+00:00\\\"\",\"updated_at\":\"\\\"2017-01-05T20:31:41+00:00\\\"\",\"test\":\"null\",\"charge_type\":\"null\",\"decorated_return_url\":\"http://google.com?charge_id=675931192\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Activate a one-time charge"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/shop.json": {
"get": {
"description": "https://help.shopify.com/api/reference/shop",
"summary": "Get the configuration of the shop account",
"tags": [
"Shop"
],
"operationId": "AdminShopJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/shop.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get the configuration of the shop account",
"x-testDescription": "https://help.shopify.com/api/reference/shop"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/62581763.json": {
"get": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Get a single blog by its ID",
"tags": [
"Blog"
],
"operationId": "AdminBlogs62581763JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs/62581763.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single blog by its ID",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/metafields/33058305934.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get a single product metafield using the metafield's nested resource path",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555Metafields33058305934JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/metafields/33058305934.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single product metafield using the metafield's nested resource path",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Update an existing metafield belonging to a product",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555Metafields33058305934JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnExistingMetafieldBelongingToAProductrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/products/7990943555/metafields/33058305934.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"metafield\":{\"id\":845366454,\"value\":\"titre\",\"value_type\":\"string\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an existing metafield belonging to a product",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Delete a product metafield",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555Metafields33058305934JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/products/7990943555/metafields/33058305934.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product metafield",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/261414723/provinces.json": {
"get": {
"description": "https://help.shopify.com/api/reference/province#index",
"summary": "Get all provinces",
"tags": [
"Province"
],
"operationId": "AdminCountries261414723ProvincesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries/261414723/provinces.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all provinces",
"x-testDescription": "https://help.shopify.com/api/reference/province#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/discounts/2951196163/disable.json": {
"post": {
"description": "https://help.shopify.com/api/reference/discount#create",
"summary": "Disable a discount",
"tags": [
"Discount"
],
"operationId": "AdminDiscounts2951196163DisableJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DisableADiscountrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/discounts/2951196163/disable.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"discount\":{\"discount_type\":\"fixed_amount\",\"value\":\"10.00\",\"code\":\"fortunamajor\",\"minimum_order_amount\":\"40.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Disable a discount",
"x-testDescription": "https://help.shopify.com/api/reference/discount#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/redirects/count/7376372.json": {
"get": {
"description": "https://help.shopify.com/api/reference/redirect#index",
"summary": "Get a single URL redirect",
"tags": [
"Redirect"
],
"operationId": "AdminRedirectsCount7376372JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/redirects/count/7376372.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single URL redirect",
"x-testDescription": "https://help.shopify.com/api/reference/redirect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/smart_collections/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/smartcollection#index",
"summary": "Get a count of all collections",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollectionsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/smart_collections/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all collections",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/metafields.json": {
"get": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Get all metafields that belong to a product",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555MetafieldsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/metafields.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all metafields that belong to a product",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/metafield#index",
"summary": "Create a new metafield for a product.",
"tags": [
"Metafield"
],
"operationId": "AdminProducts7990943555MetafieldsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewMetafieldForAProduct.request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/products/7990943555/metafields.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"metafield\":{\"namespace\":\"inventory\",\"key\":\"warehouse\",\"value\":25,\"value_type\":\"integer\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new metafield for a product.",
"x-testDescription": "https://help.shopify.com/api/reference/metafield#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Get all products",
"tags": [
"Product"
],
"operationId": "AdminProductsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all products",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Create a new product with multiple product variants",
"tags": [
"Product"
],
"operationId": "AdminProductsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductWithMultipleProductVariantsrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/products.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"product\":{\"title\":\"Burton Custom Freestyle 151\",\"body_html\":\"<strong>Good snowboard!</strong>\",\"vendor\":\"Burton\",\"product_type\":\"Snowboard\",\"variants\":[{\"option1\":\"First\",\"price\":\"10.00\",\"sku\":123},{\"option1\":\"Second\",\"price\":\"20.00\",\"sku\":123}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new product with multiple product variants",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customer_saved_searches/2029905294.json": {
"put": {
"description": "https://help.shopify.com/api/reference/customeraddress#update",
"summary": "Update an existing Customer Saved Search",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearches2029905294JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnExistingCustomerSavedSearchrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/customer_saved_searches/2029905294.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"customer_saved_search\":{\"id\":2029905294,\"name\":\"This Name Has Been Changed\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an existing Customer Saved Search",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/customeraddress#destroy",
"summary": "Delete an existing Customer Saved Search",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearches2029905294JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/customer_saved_searches/2029905294.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an existing Customer Saved Search",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customer_saved_searches/1189248515.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get one customer saved search by ID",
"tags": [
"CustomerSavedSearch"
],
"operationId": "AdminCustomerSavedSearches1189248515JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customer_saved_searches/1189248515.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get one customer saved search by ID",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/custom_collections/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customcollection#index",
"summary": "Get a count of all custom collections",
"tags": [
"CustomCollection"
],
"operationId": "AdminCustomCollectionsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/custom_collections/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all custom collections",
"x-testDescription": "https://help.shopify.com/api/reference/customcollection#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/script_tags/108074126.json": {
"put": {
"description": "https://help.shopify.com/api/reference/scripttag#update",
"summary": "update a script tag",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTags108074126JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAScriptTagrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/script_tags/108074126.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"script_tag\":{\"id\":596726825,\"src\":\"https://somewhere-else.com/another.js\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "update a script tag",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#update"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/scripttag#destroy",
"summary": "remove a script tag",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTags108074126JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/script_tags/108074126.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "remove a script tag",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/events.json": {
"get": {
"description": "https://help.shopify.com/api/reference/event#articles",
"summary": "Get all the events from a particular product",
"tags": [
"Event"
],
"operationId": "AdminProducts7990943555EventsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555/events.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all the events from a particular product",
"x-testDescription": "https://help.shopify.com/api/reference/event#articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/themes/164593742.json": {
"put": {
"description": "https://help.shopify.com/api/reference/theme#create",
"summary": "Update a theme's attributes",
"tags": [
"Theme"
],
"operationId": "AdminThemes164593742JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateATheme'sAttributesrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/themes/164593742.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"theme\":{\"id\":752253240,\"role\":\"main\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a theme's attributes",
"x-testDescription": "https://help.shopify.com/api/reference/theme#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "https://help.shopify.com/api/reference/theme#destroy",
"summary": "Delete a theme",
"tags": [
"Theme"
],
"operationId": "AdminThemes164593742JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/themes/164593742.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a theme",
"x-testDescription": "https://help.shopify.com/api/reference/theme#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/orders/4554953422/refunds/646546.json": {
"get": {
"description": "https://help.shopify.com/api/reference/refund#index",
"summary": "Get a representation of a single refund",
"tags": [
"Refund"
],
"operationId": "AdminOrders4554953422Refunds646546JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/orders/4554953422/refunds/646546.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a representation of a single refund",
"x-testDescription": "https://help.shopify.com/api/reference/refund#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/events/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/event#articles",
"summary": "Count all the events",
"tags": [
"Event"
],
"operationId": "AdminEventsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/events/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Count all the events",
"x-testDescription": "https://help.shopify.com/api/reference/event#articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/recurring_application_charges.json": {
"post": {
"description": "https://help.shopify.com/api/reference/recurringapplicationcharge#create",
"summary": "Create a new charge",
"tags": [
"RecurringApplicationCharge"
],
"operationId": "AdminRecurringApplicationChargesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewChargerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/recurring_application_charges.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"recurring_application_charge\":{\"name\":\"Super Duper Plan\",\"price\":10.0,\"return_url\":\"http://super-duper.shopifyapps.com\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new charge",
"x-testDescription": "https://help.shopify.com/api/reference/recurringapplicationcharge#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555/variants/34705478094.json": {
"delete": {
"description": "https://help.shopify.com/api/reference/product_variant#destroy",
"summary": "Delete a product variant",
"tags": [
"ProductVariant"
],
"operationId": "AdminProducts7990943555Variants34705478094JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteAProductVariantrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/products/7990943555/variants/34705478094.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"page\":{\"id\":131092082,\"published\":true}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product variant",
"x-testDescription": "https://help.shopify.com/api/reference/product_variant#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/comment#index",
"summary": "Get a count of all comments",
"tags": [
"comments"
],
"operationId": "AdminCommentsCountJsonGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/comments/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all comments",
"x-testDescription": "https://help.shopify.com/api/reference/comment#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/script_tags/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/scripttag#index",
"summary": "Get a count of all script tags",
"tags": [
"ScriptTag"
],
"operationId": "AdminScriptTagsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/script_tags/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all script tags",
"x-testDescription": "https://help.shopify.com/api/reference/scripttag#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/collects/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/collect#index",
"summary": "Get a count of all collects",
"tags": [
"Collect"
],
"operationId": "AdminCollectsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/collects/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all collects",
"x-testDescription": "https://help.shopify.com/api/reference/collect#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customer#index",
"summary": "Retrieve all customers",
"tags": [
"Customer"
],
"operationId": "AdminCustomersJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieve all customers",
"x-testDescription": "https://help.shopify.com/api/reference/customer#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/customer#create",
"summary": "Create a new customer record",
"tags": [
"Customer"
],
"operationId": "AdminCustomersJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCustomerRecordrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/customers.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"customer\":{\"first_name\":\"Steve\",\"last_name\":\"Lastnameson\",\"email\":\"steve.lastnameson@example.com\",\"phone\":\"+15142546011\",\"verified_email\":true,\"addresses\":[{\"address1\":\"123 Oak St\",\"city\":\"Ottawa\",\"province\":\"ON\",\"phone\":\"555-1212\",\"zip\":\"123 ABC\",\"last_name\":\"Lastnameson\",\"first_name\":\"Mother\",\"country\":\"CA\"}]}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new customer record",
"x-testDescription": "https://help.shopify.com/api/reference/customer#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/261414723/provinces/4003640003.json": {
"get": {
"description": "https://help.shopify.com/api/reference/province#index",
"summary": "get a single province",
"tags": [
"Province"
],
"operationId": "AdminCountries261414723Provinces4003640003JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries/261414723/provinces/4003640003.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "get a single province",
"x-testDescription": "https://help.shopify.com/api/reference/province#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "https://help.shopify.com/api/reference/province#index",
"summary": "Update a province's tax rate",
"tags": [
"Province"
],
"operationId": "AdminCountries261414723Provinces4003640003JsonPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProvince'sTaxRaterequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/admin/countries/261414723/provinces/4003640003.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"province\":{\"id\":224293623,\"tax\":0.15}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a province's tax rate",
"x-testDescription": "https://help.shopify.com/api/reference/province#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/smart_collections/408154574.json": {
"delete": {
"description": "https://help.shopify.com/api/reference/smartcollection#destroy",
"summary": "Delete a single collection",
"tags": [
"SmartCollection"
],
"operationId": "AdminSmartCollections408154574JsonDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/admin/smart_collections/408154574.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a single collection",
"x-testDescription": "https://help.shopify.com/api/reference/smartcollection#destroy"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/261414723.json": {
"get": {
"description": "https://help.shopify.com/api/reference/country#index",
"summary": "Show Country",
"tags": [
"Country"
],
"operationId": "AdminCountries261414723JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries/261414723.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Show Country",
"x-testDescription": "https://help.shopify.com/api/reference/country#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/comments/2941387470/restore.json": {
"post": {
"description": "https://help.shopify.com/api/reference/comment#create",
"summary": "restore a comment",
"tags": [
"comments"
],
"operationId": "AdminComments2941387470RestoreJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/comments/2941387470/restore.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "restore a comment",
"x-testDescription": "https://help.shopify.com/api/reference/comment#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"//admin/collects.json": {
"post": {
"description": "https://help.shopify.com/api/reference/collect#create",
"summary": "Add a product to a collection",
"tags": [
"Collect"
],
"operationId": "AdminCollectsJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddAProductToACollectionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "//admin/collects.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"collect\":{\"product_id\":921728736,\"collection_id\":841564295}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add a product to a collection",
"x-testDescription": "https://help.shopify.com/api/reference/collect#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/blogs/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/blog#index",
"summary": "Get a count of all blogs",
"tags": [
"Blog"
],
"operationId": "AdminBlogsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/blogs/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all blogs",
"x-testDescription": "https://help.shopify.com/api/reference/blog#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/countries/count.json": {
"get": {
"description": "https://help.shopify.com/api/reference/country#index",
"summary": "Get a count of all countries",
"tags": [
"Country"
],
"operationId": "AdminCountriesCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/countries/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of all countries",
"x-testDescription": "https://help.shopify.com/api/reference/country#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/products/7990943555.json": {
"get": {
"description": "https://help.shopify.com/api/reference/product#index",
"summary": "Get a single product",
"tags": [
"Product"
],
"operationId": "AdminProducts7990943555JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/products/7990943555.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single product",
"x-testDescription": "https://help.shopify.com/api/reference/product#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/webhooks/93838927.json": {
"get": {
"description": "https://help.shopify.com/api/reference/webhook#index",
"summary": "Get a single webhook by its id.",
"tags": [
"Webhook"
],
"operationId": "AdminWebhooks93838927JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/webhooks/93838927.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single webhook by its id.",
"x-testDescription": "https://help.shopify.com/api/reference/webhook#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/customers/3989659651/addresses/5436816654.json": {
"get": {
"description": "https://help.shopify.com/api/reference/customeraddress#index",
"summary": "Get a single customers address",
"tags": [
"CustomerAddress"
],
"operationId": "AdminCustomers3989659651Addresses5436816654JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/customers/3989659651/addresses/5436816654.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single customers address",
"x-testDescription": "https://help.shopify.com/api/reference/customeraddress#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/articles/authors.json": {
"get": {
"summary": "Get a list of all the authors of articles",
"tags": [
"Article"
],
"operationId": "AdminArticlesAuthorsJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/articles/authors.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a list of all the authors of articles"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/themes.json": {
"get": {
"description": "https://help.shopify.com/api/reference/theme#index",
"summary": "Get all shop themes",
"tags": [
"Theme"
],
"operationId": "AdminThemesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/themes.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all shop themes",
"x-testDescription": "https://help.shopify.com/api/reference/theme#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "https://help.shopify.com/api/reference/theme#create",
"summary": "Create a new theme",
"tags": [
"Theme"
],
"operationId": "AdminThemesJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewThemerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/themes.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"theme\":{\"name\":\"Lemongrass\",\"src\":\"http://themes.shopify.com/theme.zip\",\"role\":\"main\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new theme",
"x-testDescription": "https://help.shopify.com/api/reference/theme#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/shipping_zones.json": {
"get": {
"description": "https://help.shopify.com/api/reference/shipping_zone#index",
"summary": "Show list of shipping zones",
"tags": [
"ShippingZone"
],
"operationId": "AdminShippingZonesJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/shipping_zones.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Show list of shipping zones",
"x-testDescription": "https://help.shopify.com/api/reference/shipping_zone#index"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/checkouts/count.json": {
"get": {
"summary": "Get a count of checkouts",
"tags": [
"Abandoned Checkout"
],
"operationId": "AdminCheckoutsCountJsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/checkouts/count.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a count of checkouts"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/pages/169722563.json": {
"get": {
"description": "https://help.shopify.com/api/reference/page",
"summary": "Get a single page by its ID",
"tags": [
"Page"
],
"operationId": "AdminPages169722563JsonGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/admin/pages/169722563.json",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single page by its ID",
"x-testDescription": "https://help.shopify.com/api/reference/page"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/admin/discounts/2951196163/enable.json": {
"post": {
"description": "https://help.shopify.com/api/reference/discount#create",
"summary": "Enable a discount",
"tags": [
"Discount"
],
"operationId": "AdminDiscounts2951196163EnableJsonPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/EnableADiscountrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/admin/discounts/2951196163/enable.json",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"discount\":{\"discount_type\":\"fixed_amount\",\"value\":\"10.00\",\"code\":\"fortunamajor\",\"minimum_order_amount\":\"40.00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Enable a discount",
"x-testDescription": "https://help.shopify.com/api/reference/discount#create"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"CreateANewCustomCollectionrequest": {
"title": "Create a new custom collectionRequest",
"example": {
"custom_collection": {
"title": "Macbooks",
"image": {
"src": "http://example.com/rails_logo.gif"
}
}
},
"type": "object",
"properties": {
"custom_collection": {
"$ref": "#/definitions/CustomCollection"
}
},
"required": [
"custom_collection"
]
},
"CustomCollection": {
"title": "CustomCollection",
"example": {
"title": "Macbooks",
"image": {
"src": "http://example.com/rails_logo.gif"
}
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Macbooks",
"type": "string"
},
"image": {
"$ref": "#/definitions/Image"
}
},
"required": [
"title",
"image"
]
},
"Image": {
"title": "Image",
"example": {
"src": "http://example.com/rails_logo.gif"
},
"type": "object",
"properties": {
"src": {
"description": "",
"example": "http://example.com/rails_logo.gif",
"type": "string"
}
},
"required": [
"src"
]
},
"UpdateACommentrequest": {
"title": "Update a commentRequest",
"example": {
"comment": {
"id": 2941387470,
"body": "You can even update through a web service.",
"author": "Your new name",
"email": "your@updated-email.com",
"published_at": "2017-01-05T20:37:21.046Z"
}
},
"type": "object",
"properties": {
"comment": {
"$ref": "#/definitions/Comment"
}
},
"required": [
"comment"
]
},
"Comment": {
"title": "Comment",
"example": {
"id": 2941387470,
"body": "You can even update through a web service.",
"author": "Your new name",
"email": "your@updated-email.com",
"published_at": "2017-01-05T20:37:21.046Z"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 2941387470,
"type": "integer",
"format": "int64"
},
"body": {
"description": "",
"example": "You can even update through a web service.",
"type": "string"
},
"author": {
"description": "",
"example": "Your new name",
"type": "string"
},
"email": {
"description": "",
"example": "your@updated-email.com",
"type": "string"
},
"published_at": {
"description": "",
"example": "1/5/2017 8:37:21 PM",
"type": "string"
}
},
"required": [
"id",
"body",
"author",
"email",
"published_at"
]
},
"UpdateASingleCollectionrequest": {
"title": "Update a single collectionRequest",
"example": {
"smart_collection": {
"id": 482865238,
"body_html": "<p>5000 songs in your pocket</p>"
}
},
"type": "object",
"properties": {
"smart_collection": {
"$ref": "#/definitions/SmartCollection"
}
},
"required": [
"smart_collection"
]
},
"SmartCollection": {
"title": "SmartCollection",
"example": {
"id": 482865238,
"body_html": "<p>5000 songs in your pocket</p>"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 482865238,
"type": "integer",
"format": "int32"
},
"body_html": {
"description": "",
"example": "<p>5000 songs in your pocket</p>",
"type": "string"
}
},
"required": [
"id",
"body_html"
]
},
"UpdateAProductAndOneOfItsVariantsrequest": {
"title": "Update a product and one of its variantsRequest",
"example": {
"product": {
"id": 9579007950,
"title": "Updated Product Title",
"variants": [
{
"id": 25831837123,
"price": "2000.00",
"sku": "Updating the Product SKU"
}
]
}
},
"type": "object",
"properties": {
"product": {
"$ref": "#/definitions/Product"
}
},
"required": [
"product"
]
},
"Product": {
"title": "Product",
"example": {
"id": 9579007950,
"title": "Updated Product Title",
"variants": [
{
"id": 25831837123,
"price": "2000.00",
"sku": "Updating the Product SKU"
}
]
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 9579007950,
"type": "integer",
"format": "int64"
},
"title": {
"description": "",
"example": "Updated Product Title",
"type": "string"
},
"variants": {
"description": "",
"example": [
{
"id": 25831837123,
"price": "2000.00",
"sku": "Updating the Product SKU"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Variant"
}
}
},
"required": [
"id",
"title",
"variants"
]
},
"Variant": {
"title": "Variant",
"example": {
"id": 25831837123,
"price": "2000.00",
"sku": "Updating the Product SKU"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 25831837123,
"type": "integer",
"format": "int64"
},
"price": {
"description": "",
"example": "2000.00",
"type": "string"
},
"sku": {
"description": "",
"example": "Updating the Product SKU",
"type": "string"
}
},
"required": [
"id",
"price",
"sku"
]
},
"CalculateARefundForALineItemAndShippingrequest": {
"title": "Calculate a refund for a line item and shippingRequest",
"example": {
"refund": {
"shipping": {
"full_refund": true
},
"refund_line_items": [
{
"line_item_id": 25831837123,
"quantity": 1
}
]
}
},
"type": "object",
"properties": {
"refund": {
"$ref": "#/definitions/Refund"
}
},
"required": [
"refund"
]
},
"Refund": {
"title": "Refund",
"example": {
"shipping": {
"full_refund": true
},
"refund_line_items": [
{
"line_item_id": 25831837123,
"quantity": 1
}
]
},
"type": "object",
"properties": {
"shipping": {
"$ref": "#/definitions/Shipping"
},
"refund_line_items": {
"description": "",
"example": [
{
"line_item_id": 25831837123,
"quantity": 1
}
],
"type": "array",
"items": {
"$ref": "#/definitions/RefundLineItem"
}
}
},
"required": [
"shipping",
"refund_line_items"
]
},
"Shipping": {
"title": "Shipping",
"example": {
"full_refund": true
},
"type": "object",
"properties": {
"full_refund": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"full_refund"
]
},
"RefundLineItem": {
"title": "RefundLineItem",
"example": {
"line_item_id": 25831837123,
"quantity": 1
},
"type": "object",
"properties": {
"line_item_id": {
"description": "",
"example": 25831837123,
"type": "integer",
"format": "int64"
},
"quantity": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
}
},
"required": [
"line_item_id",
"quantity"
]
},
"CreateANewMetafieldForAStore.request": {
"title": "Create a new metafield for a store.Request",
"example": {
"metafield": {
"namespace": "inventory",
"key": "warehouse",
"value": 25,
"value_type": "integer"
}
},
"type": "object",
"properties": {
"metafield": {
"$ref": "#/definitions/Metafield"
}
},
"required": [
"metafield"
]
},
"Metafield": {
"title": "Metafield",
"example": {
"namespace": "inventory",
"key": "warehouse",
"value": 25,
"value_type": "integer"
},
"type": "object",
"properties": {
"namespace": {
"description": "",
"example": "inventory",
"type": "string"
},
"key": {
"description": "",
"example": "warehouse",
"type": "string"
},
"value": {
"description": "",
"example": 25,
"type": "integer",
"format": "int32"
},
"value_type": {
"description": "",
"example": "integer",
"type": "string"
}
},
"required": [
"namespace",
"key",
"value",
"value_type"
]
},
"DisableAGiftCardrequest": {
"title": "Disable a gift cardRequest",
"example": {
"gift_card": {
"id": 61810574
}
},
"type": "object",
"properties": {
"gift_card": {
"$ref": "#/definitions/GiftCard"
}
},
"required": [
"gift_card"
]
},
"GiftCard": {
"title": "GiftCard",
"example": {
"id": 61810574
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 61810574,
"type": "integer",
"format": "int32"
}
},
"required": [
"id"
]
},
"UpdateAWebhookrequest": {
"title": "Update a WebhookRequest",
"example": {
"webhook": {
"id": 4759306,
"address": "http://somewhere-else.com/"
}
},
"type": "object",
"properties": {
"webhook": {
"$ref": "#/definitions/Webhook"
}
},
"required": [
"webhook"
]
},
"Webhook": {
"title": "Webhook",
"example": {
"id": 4759306,
"address": "http://somewhere-else.com/"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 4759306,
"type": "integer",
"format": "int32"
},
"address": {
"description": "",
"example": "http://somewhere-else.com/",
"type": "string"
}
},
"required": [
"id",
"address"
]
},
"UpdateAnArticlerequest": {
"title": "Update an articleRequest",
"example": {
"article": {
"title": "oi"
}
},
"type": "object",
"properties": {
"article": {
"$ref": "#/definitions/Article"
}
},
"required": [
"article"
]
},
"Article": {
"title": "Article",
"example": {
"title": "oi"
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "oi",
"type": "string"
}
},
"required": [
"title"
]
},
"CancelingAndRefundingAnOrderrequest": {
"title": "Canceling and refunding an OrderRequest",
"example": {
"note": "Broke in shipping",
"amount": "10.00"
},
"type": "object",
"properties": {
"note": {
"description": "",
"example": "Broke in shipping",
"type": "string"
},
"amount": {
"description": "",
"example": "10.00",
"type": "string"
}
},
"required": [
"note",
"amount"
]
},
"AddAFraudRiskForProxyDetectionrequest": {
"title": "Add a fraud risk for Proxy detectionRequest",
"example": {
"risk": {
"message": "This order came from an anonymous proxy",
"recommendation": "cancel",
"score": 1.0,
"source": "External",
"cause_cancel": true,
"display": true
}
},
"type": "object",
"properties": {
"risk": {
"$ref": "#/definitions/Risk"
}
},
"required": [
"risk"
]
},
"Risk": {
"title": "Risk",
"example": {
"message": "This order came from an anonymous proxy",
"recommendation": "cancel",
"score": 1.0,
"source": "External",
"cause_cancel": true,
"display": true
},
"type": "object",
"properties": {
"message": {
"description": "",
"example": "This order came from an anonymous proxy",
"type": "string"
},
"recommendation": {
"description": "",
"example": "cancel",
"type": "string"
},
"score": {
"description": "",
"example": 1,
"type": "number",
"format": "double"
},
"source": {
"description": "",
"example": "External",
"type": "string"
},
"cause_cancel": {
"description": "",
"example": true,
"type": "boolean"
},
"display": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"message",
"recommendation",
"score",
"source",
"cause_cancel",
"display"
]
},
"CreateANewBlogrequest": {
"title": "Create a new blogRequest",
"example": {
"blog": {
"title": "Test Blog via API"
}
},
"type": "object",
"properties": {
"blog": {
"$ref": "#/definitions/Blog"
}
},
"required": [
"blog"
]
},
"Blog": {
"title": "Blog",
"example": {
"title": "Test Blog via API"
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Test Blog via API",
"type": "string"
}
},
"required": [
"title"
]
},
"CreateACountryrequest": {
"title": "Create a countryRequest",
"example": {
"country": {
"code": "FR",
"tax": 0.25
}
},
"type": "object",
"properties": {
"country": {
"$ref": "#/definitions/Country"
}
},
"required": [
"country"
]
},
"Country": {
"title": "Country",
"example": {
"code": "FR",
"tax": 0.25
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "FR",
"type": "string"
},
"tax": {
"description": "",
"example": 0.25,
"type": "number",
"format": "double"
}
},
"required": [
"code",
"tax"
]
},
"CreateAFulfillmentServicerequest": {
"title": "Create a fulfillment serviceRequest",
"example": {
"fulfillment_service": {
"name": "MarsFulfillment",
"callback_url": "http://google.com",
"inventory_management": true,
"tracking_support": true,
"requires_shipping_method": true,
"format": "json"
}
},
"type": "object",
"properties": {
"fulfillment_service": {
"$ref": "#/definitions/FulfillmentService"
}
},
"required": [
"fulfillment_service"
]
},
"FulfillmentService": {
"title": "FulfillmentService",
"example": {
"name": "MarsFulfillment",
"callback_url": "http://google.com",
"inventory_management": true,
"tracking_support": true,
"requires_shipping_method": true,
"format": "json"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "MarsFulfillment",
"type": "string"
},
"callback_url": {
"description": "",
"example": "http://google.com",
"type": "string"
},
"inventory_management": {
"description": "",
"example": true,
"type": "boolean"
},
"tracking_support": {
"description": "",
"example": true,
"type": "boolean"
},
"requires_shipping_method": {
"description": "",
"example": true,
"type": "boolean"
},
"format": {
"description": "",
"example": "json",
"type": "string"
}
},
"required": [
"name",
"callback_url",
"inventory_management",
"tracking_support",
"requires_shipping_method",
"format"
]
},
"UpdateAPagerequest": {
"title": "update a pageRequest",
"example": {
"page": {
"id": 131092082,
"published": true
}
},
"type": "object",
"properties": {
"page": {
"$ref": "#/definitions/Page"
}
},
"required": [
"page"
]
},
"Page": {
"title": "Page",
"example": {
"id": 131092082,
"published": true
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 131092082,
"type": "integer",
"format": "int32"
},
"published": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"id",
"published"
]
},
"UpdatingACustomersPostalCoderequest": {
"title": "Updating a customers postal codeRequest",
"example": {
"address": {
"id": 207119551,
"zip": "90210"
}
},
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/Address"
}
},
"required": [
"address"
]
},
"Address": {
"title": "Address",
"example": {
"id": 207119551,
"zip": "90210"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 207119551,
"type": "integer",
"format": "int32"
},
"zip": {
"description": "",
"example": "90210",
"type": "string"
}
},
"required": [
"id",
"zip"
]
},
"CreateANewCommentForAnArticlerequest": {
"title": "Create a new comment for an articleRequest",
"example": {
"comment": {
"body": "I like comments\nAnd I like posting them *RESTfully*.",
"author": "Your name",
"email": "renato@basico.com",
"ip": "107.20.160.121",
"blog_id": 62581763,
"article_id": 128701187
}
},
"type": "object",
"properties": {
"comment": {
"$ref": "#/definitions/Comment36"
}
},
"required": [
"comment"
]
},
"Comment36": {
"title": "Comment36",
"example": {
"body": "I like comments\nAnd I like posting them *RESTfully*.",
"author": "Your name",
"email": "renato@basico.com",
"ip": "107.20.160.121",
"blog_id": 62581763,
"article_id": 128701187
},
"type": "object",
"properties": {
"body": {
"description": "",
"example": "I like comments\nAnd I like posting them *RESTfully*.",
"type": "string"
},
"author": {
"description": "",
"example": "Your name",
"type": "string"
},
"email": {
"description": "",
"example": "renato@basico.com",
"type": "string"
},
"ip": {
"description": "",
"example": "107.20.160.121",
"type": "string"
},
"blog_id": {
"description": "",
"example": 62581763,
"type": "integer",
"format": "int32"
},
"article_id": {
"description": "",
"example": 128701187,
"type": "integer",
"format": "int32"
}
},
"required": [
"body",
"author",
"email",
"ip",
"blog_id",
"article_id"
]
},
"UpdateAnExistingProductVariantrequest": {
"title": "Update an existing product variantRequest",
"example": {
"variant": {
"id": 808950810,
"option1": "Not Pink",
"price": "99.00"
}
},
"type": "object",
"properties": {
"variant": {
"$ref": "#/definitions/Variant38"
}
},
"required": [
"variant"
]
},
"Variant38": {
"title": "Variant38",
"example": {
"id": 808950810,
"option1": "Not Pink",
"price": "99.00"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 808950810,
"type": "integer",
"format": "int32"
},
"option1": {
"description": "",
"example": "Not Pink",
"type": "string"
},
"price": {
"description": "",
"example": "99.00",
"type": "string"
}
},
"required": [
"id",
"option1",
"price"
]
},
"CreateANewCollectionrequest": {
"title": "Create a new collectionRequest",
"example": {
"smart_collection": {
"title": "Macbooks",
"published": false
}
},
"type": "object",
"properties": {
"smart_collection": {
"$ref": "#/definitions/SmartCollection40"
}
},
"required": [
"smart_collection"
]
},
"SmartCollection40": {
"title": "SmartCollection40",
"example": {
"title": "Macbooks",
"published": false
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Macbooks",
"type": "string"
},
"published": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"title",
"published"
]
},
"DeleteAFulfillmentEvent.request": {
"title": "Delete a fulfillment event.Request",
"example": {
"event": {
"status": "delivered"
}
},
"type": "object",
"properties": {
"event": {
"$ref": "#/definitions/Event"
}
},
"required": [
"event"
]
},
"Event": {
"title": "Event",
"example": {
"status": "delivered"
},
"type": "object",
"properties": {
"status": {
"description": "",
"example": "delivered",
"type": "string"
}
},
"required": [
"status"
]
},
"CreateACarrierServicerequest": {
"title": "Create a carrier serviceRequest",
"example": {
"carrier_service": {
"name": "Shipping Rate Provider",
"callback_url": "http://shippingrateprovider.com",
"service_discovery": true
}
},
"type": "object",
"properties": {
"carrier_service": {
"$ref": "#/definitions/CarrierService"
}
},
"required": [
"carrier_service"
]
},
"CarrierService": {
"title": "CarrierService",
"example": {
"name": "Shipping Rate Provider",
"callback_url": "http://shippingrateprovider.com",
"service_discovery": true
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Shipping Rate Provider",
"type": "string"
},
"callback_url": {
"description": "",
"example": "http://shippingrateprovider.com",
"type": "string"
},
"service_discovery": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"name",
"callback_url",
"service_discovery"
]
},
"CreateANewPagerequest": {
"title": "Create a new pageRequest",
"example": {
"page": {
"title": "Warranty information",
"body_html": "<h1>Warranty</h1>\n<p><strong>Forget it</strong>, we aint giving you nothing</p>",
"published": false
}
},
"type": "object",
"properties": {
"page": {
"$ref": "#/definitions/Page46"
}
},
"required": [
"page"
]
},
"Page46": {
"title": "Page46",
"example": {
"title": "Warranty information",
"body_html": "<h1>Warranty</h1>\n<p><strong>Forget it</strong>, we aint giving you nothing</p>",
"published": false
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Warranty information",
"type": "string"
},
"body_html": {
"description": "",
"example": "<h1>Warranty</h1>\n<p><strong>Forget it</strong>, we aint giving you nothing</p>",
"type": "string"
},
"published": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"title",
"body_html",
"published"
]
},
"RemoveAProductFromTheShoprequest": {
"title": "Remove a product from the shopRequest",
"example": {
"product": {
"id": 9579007950,
"title": "Updated Product Title",
"variants": [
{
"id": 25831837123,
"price": "2000.00",
"sku": "Updating the Product SKU"
}
]
}
},
"type": "object",
"properties": {
"product": {
"$ref": "#/definitions/Product"
}
},
"required": [
"product"
]
},
"DeleteAnErroneousRiskEntryrequest": {
"title": "Delete an erroneous risk entryRequest",
"example": {
"risk": {
"id": 284138680,
"message": "After further review, this is a legitimate order",
"recommendation": "accept",
"source": "External",
"cause_cancel": false,
"score": 0.0
}
},
"type": "object",
"properties": {
"risk": {
"$ref": "#/definitions/Risk51"
}
},
"required": [
"risk"
]
},
"Risk51": {
"title": "Risk51",
"example": {
"id": 284138680,
"message": "After further review, this is a legitimate order",
"recommendation": "accept",
"source": "External",
"cause_cancel": false,
"score": 0.0
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 284138680,
"type": "integer",
"format": "int32"
},
"message": {
"description": "",
"example": "After further review, this is a legitimate order",
"type": "string"
},
"recommendation": {
"description": "",
"example": "accept",
"type": "string"
},
"source": {
"description": "",
"example": "External",
"type": "string"
},
"cause_cancel": {
"description": "",
"example": false,
"type": "boolean"
},
"score": {
"description": "",
"example": 0,
"type": "number",
"format": "double"
}
},
"required": [
"id",
"message",
"recommendation",
"source",
"cause_cancel",
"score"
]
},
"UpdateACountryrequest": {
"title": "update a countryRequest",
"example": {
"country": {
"id": 444574734,
"tax": 0.1
}
},
"type": "object",
"properties": {
"country": {
"$ref": "#/definitions/Country53"
}
},
"required": [
"country"
]
},
"Country53": {
"title": "Country53",
"example": {
"id": 444574734,
"tax": 0.1
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 444574734,
"type": "integer",
"format": "int32"
},
"tax": {
"description": "",
"example": 0.1,
"type": "number",
"format": "double"
}
},
"required": [
"id",
"tax"
]
},
"ModifyAnExistingProductImagerequest": {
"title": "Modify an existing product imageRequest",
"example": {
"image": {
"id": 850703190,
"position": 2,
"metafields": [
{
"key": "alt",
"value": "new alt tag content",
"value_type": "string",
"namespace": "tags"
}
]
}
},
"type": "object",
"properties": {
"image": {
"$ref": "#/definitions/Image55"
}
},
"required": [
"image"
]
},
"Image55": {
"title": "Image55",
"example": {
"id": 850703190,
"position": 2,
"metafields": [
{
"key": "alt",
"value": "new alt tag content",
"value_type": "string",
"namespace": "tags"
}
]
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 850703190,
"type": "integer",
"format": "int32"
},
"position": {
"description": "",
"example": 2,
"type": "integer",
"format": "int32"
},
"metafields": {
"description": "",
"example": [
{
"key": "alt",
"value": "new alt tag content",
"value_type": "string",
"namespace": "tags"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Metafield56"
}
}
},
"required": [
"id",
"position",
"metafields"
]
},
"Metafield56": {
"title": "Metafield56",
"example": {
"key": "alt",
"value": "new alt tag content",
"value_type": "string",
"namespace": "tags"
},
"type": "object",
"properties": {
"key": {
"description": "",
"example": "alt",
"type": "string"
},
"value": {
"description": "",
"example": "new alt tag content",
"type": "string"
},
"value_type": {
"description": "",
"example": "string",
"type": "string"
},
"namespace": {
"description": "",
"example": "tags",
"type": "string"
}
},
"required": [
"key",
"value",
"value_type",
"namespace"
]
},
"DeleteADiscountrequest": {
"title": "Delete a discountRequest",
"example": {
"discount": {
"discount_type": "fixed_amount",
"value": "10.00",
"code": "fortunamajor",
"minimum_order_amount": "40.00"
}
},
"type": "object",
"properties": {
"discount": {
"$ref": "#/definitions/Discount"
}
},
"required": [
"discount"
]
},
"Discount": {
"title": "Discount",
"example": {
"discount_type": "fixed_amount",
"value": "10.00",
"code": "fortunamajor",
"minimum_order_amount": "40.00"
},
"type": "object",
"properties": {
"discount_type": {
"description": "",
"example": "fixed_amount",
"type": "string"
},
"value": {
"description": "",
"example": "10.00",
"type": "string"
},
"code": {
"description": "",
"example": "fortunamajor",
"type": "string"
},
"minimum_order_amount": {
"description": "",
"example": "40.00",
"type": "string"
}
},
"required": [
"discount_type",
"value",
"code",
"minimum_order_amount"
]
},
"CreateAPendingOrderWithAnExistingCustomerrequest": {
"title": "Create a pending order with an existing customerRequest",
"example": {
"order": {
"line_items": [
{
"variant_id": 33214924878,
"quantity": 1
}
],
"customer": {
"id": 3989659651
},
"financial_status": "pending"
}
},
"type": "object",
"properties": {
"order": {
"$ref": "#/definitions/Order"
}
},
"required": [
"order"
]
},
"Order": {
"title": "Order",
"example": {
"line_items": [
{
"variant_id": 33214924878,
"quantity": 1
}
],
"customer": {
"id": 3989659651
},
"financial_status": "pending"
},
"type": "object",
"properties": {
"line_items": {
"description": "",
"example": [
{
"variant_id": 33214924878,
"quantity": 1
}
],
"type": "array",
"items": {
"$ref": "#/definitions/LineItem"
}
},
"customer": {
"$ref": "#/definitions/Customer"
},
"financial_status": {
"description": "",
"example": "pending",
"type": "string"
}
},
"required": [
"line_items",
"customer",
"financial_status"
]
},
"LineItem": {
"title": "LineItem",
"example": {
"variant_id": 33214924878,
"quantity": 1
},
"type": "object",
"properties": {
"variant_id": {
"description": "",
"example": 33214924878,
"type": "integer",
"format": "int64"
},
"quantity": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
}
},
"required": [
"variant_id",
"quantity"
]
},
"Customer": {
"title": "Customer",
"example": {
"id": 3989659651
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 3989659651,
"type": "integer",
"format": "int64"
}
},
"required": [
"id"
]
},
"AddMetafieldToAnExistingCustomerrequest": {
"title": "Add metafield to an existing customerRequest",
"example": {
"customer": {
"id": 207119551,
"metafields": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
]
}
},
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer64"
}
},
"required": [
"customer"
]
},
"Customer64": {
"title": "Customer64",
"example": {
"id": 207119551,
"metafields": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
]
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 207119551,
"type": "integer",
"format": "int32"
},
"metafields": {
"description": "",
"example": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Metafield56"
}
}
},
"required": [
"id",
"metafields"
]
},
"CreateANewArticleForABlogrequest": {
"title": "Create a new article for a blogRequest",
"example": {
"article": {
"title": "Article test",
"author": "John Smith",
"tags": "This Post, Has Been Tagged",
"body_html": "<h1>I like articles</h1>\n<p><strong>Yea</strong>, I like posting them through <span class=\"caps\">REST</span>.</p>",
"published_at": "Thu Mar 24 15:45:47 UTC 2011"
}
},
"type": "object",
"properties": {
"article": {
"$ref": "#/definitions/Article67"
}
},
"required": [
"article"
]
},
"Article67": {
"title": "Article67",
"example": {
"title": "Article test",
"author": "John Smith",
"tags": "This Post, Has Been Tagged",
"body_html": "<h1>I like articles</h1>\n<p><strong>Yea</strong>, I like posting them through <span class=\"caps\">REST</span>.</p>",
"published_at": "Thu Mar 24 15:45:47 UTC 2011"
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Article test",
"type": "string"
},
"author": {
"description": "",
"example": "John Smith",
"type": "string"
},
"tags": {
"description": "",
"example": "This Post, Has Been Tagged",
"type": "string"
},
"body_html": {
"description": "",
"example": "<h1>I like articles</h1>\n<p><strong>Yea</strong>, I like posting them through <span class=\"caps\">REST</span>.</p>",
"type": "string"
},
"published_at": {
"description": "",
"example": "Thu Mar 24 15:45:47 UTC 2011",
"type": "string"
}
},
"required": [
"title",
"author",
"tags",
"body_html",
"published_at"
]
},
"UpdateAnExistingStoreMetafield.request": {
"title": "Update an existing store metafield.Request",
"example": {
"metafield": {
"id": 721389482,
"value": "something new",
"value_type": "string"
}
},
"type": "object",
"properties": {
"metafield": {
"$ref": "#/definitions/Metafield69"
}
},
"required": [
"metafield"
]
},
"Metafield69": {
"title": "Metafield69",
"example": {
"id": 721389482,
"value": "something new",
"value_type": "string"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 721389482,
"type": "integer",
"format": "int32"
},
"value": {
"description": "",
"example": "something new",
"type": "string"
},
"value_type": {
"description": "",
"example": "string",
"type": "string"
}
},
"required": [
"id",
"value",
"value_type"
]
},
"DestroyAFulfillmentServicerequest": {
"title": "Destroy a fulfillment serviceRequest",
"example": {
"fulfillment_service": {
"id": 755357713,
"inventory_management": false
}
},
"type": "object",
"properties": {
"fulfillment_service": {
"$ref": "#/definitions/FulfillmentService71"
}
},
"required": [
"fulfillment_service"
]
},
"FulfillmentService71": {
"title": "FulfillmentService71",
"example": {
"id": 755357713,
"inventory_management": false
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 755357713,
"type": "integer",
"format": "int32"
},
"inventory_management": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"id",
"inventory_management"
]
},
"UpdateTheExpiryDateOfAGiftCardrequest": {
"title": "Update the expiry date of a gift cardRequest",
"example": {
"gift_card": {
"expires_on": "2020-01-01"
}
},
"type": "object",
"properties": {
"gift_card": {
"$ref": "#/definitions/GiftCard73"
}
},
"required": [
"gift_card"
]
},
"GiftCard73": {
"title": "GiftCard73",
"example": {
"expires_on": "2020-01-01"
},
"type": "object",
"properties": {
"expires_on": {
"description": "",
"example": "2020-01-01",
"type": "string"
}
},
"required": [
"expires_on"
]
},
"CreateADiscountrequest": {
"title": "Create a discountRequest",
"example": {
"discount": {
"discount_type": "fixed_amount",
"value": "10.00",
"code": "fortunamajor",
"minimum_order_amount": "40.00"
}
},
"type": "object",
"properties": {
"discount": {
"$ref": "#/definitions/Discount"
}
},
"required": [
"discount"
]
},
"UpdateTrackingNumberForAFulfillment.request": {
"title": "Update tracking number for a fulfillment.Request",
"example": {
"fulfillment": {
"tracking_number": "987654321",
"id": 3770145678
}
},
"type": "object",
"properties": {
"fulfillment": {
"$ref": "#/definitions/Fulfillment"
}
},
"required": [
"fulfillment"
]
},
"Fulfillment": {
"title": "Fulfillment",
"example": {
"tracking_number": "987654321",
"id": 3770145678
},
"type": "object",
"properties": {
"tracking_number": {
"description": "",
"example": "987654321",
"type": "string"
},
"id": {
"description": "",
"example": 3770145678,
"type": "integer",
"format": "int64"
}
},
"required": [
"tracking_number",
"id"
]
},
"CreateAWebhookrequest": {
"title": "Create a webhookRequest",
"example": {
"webhook": {
"topic": "orders/create",
"address": "http://whatever.hostname.com/",
"format": "json"
}
},
"type": "object",
"properties": {
"webhook": {
"$ref": "#/definitions/Webhook79"
}
},
"required": [
"webhook"
]
},
"Webhook79": {
"title": "Webhook79",
"example": {
"topic": "orders/create",
"address": "http://whatever.hostname.com/",
"format": "json"
},
"type": "object",
"properties": {
"topic": {
"description": "",
"example": "orders/create",
"type": "string"
},
"address": {
"description": "",
"example": "http://whatever.hostname.com/",
"type": "string"
},
"format": {
"description": "",
"example": "json",
"type": "string"
}
},
"required": [
"topic",
"address",
"format"
]
},
"CreateANewRedirect.request": {
"title": "Create a new redirect.Request",
"example": {
"redirect": {
"path": "/ipod",
"target": "/pages/itunes"
}
},
"type": "object",
"properties": {
"redirect": {
"$ref": "#/definitions/Redirect"
}
},
"required": [
"redirect"
]
},
"Redirect": {
"title": "Redirect",
"example": {
"path": "/ipod",
"target": "/pages/itunes"
},
"type": "object",
"properties": {
"path": {
"description": "",
"example": "/ipod",
"type": "string"
},
"target": {
"description": "",
"example": "/pages/itunes",
"type": "string"
}
},
"required": [
"path",
"target"
]
},
"CreateANewGiftCardWithAnAutomaticallyGeneratedCoderequest": {
"title": "Create a new gift card with an automatically generated codeRequest",
"example": {
"gift_card": {
"initial_value": 25.0
}
},
"type": "object",
"properties": {
"gift_card": {
"$ref": "#/definitions/GiftCard83"
}
},
"required": [
"gift_card"
]
},
"GiftCard83": {
"title": "GiftCard83",
"example": {
"initial_value": 25.0
},
"type": "object",
"properties": {
"initial_value": {
"description": "",
"example": 25,
"type": "number",
"format": "double"
}
},
"required": [
"initial_value"
]
},
"UpdateAFulfillmentServicerequest": {
"title": "Update a fulfillment serviceRequest",
"example": {
"fulfillment_service": {
"id": 755357713,
"inventory_management": false
}
},
"type": "object",
"properties": {
"fulfillment_service": {
"$ref": "#/definitions/FulfillmentService71"
}
},
"required": [
"fulfillment_service"
]
},
"CreateANewScriptTagrequest": {
"title": "create a new script tagRequest",
"example": {
"script_tag": {
"event": "onload",
"src": "https://djavaskripped.org/fancy.js"
}
},
"type": "object",
"properties": {
"script_tag": {
"$ref": "#/definitions/ScriptTag"
}
},
"required": [
"script_tag"
]
},
"ScriptTag": {
"title": "ScriptTag",
"example": {
"event": "onload",
"src": "https://djavaskripped.org/fancy.js"
},
"type": "object",
"properties": {
"event": {
"description": "",
"example": "onload",
"type": "string"
},
"src": {
"description": "",
"example": "https://djavaskripped.org/fancy.js",
"type": "string"
}
},
"required": [
"event",
"src"
]
},
"CreateAFulfillmentEvent.request": {
"title": "Create a fulfillment event.Request",
"example": {
"event": {
"status": "delivered"
}
},
"type": "object",
"properties": {
"event": {
"$ref": "#/definitions/Event"
}
},
"required": [
"event"
]
},
"CreateANewCustomerSavedSearchrequest": {
"title": "Create a new Customer Saved SearchRequest",
"example": {
"customer_saved_search": {
"name": "Spent more than $50",
"query": "total_spent:>50"
}
},
"type": "object",
"properties": {
"customer_saved_search": {
"$ref": "#/definitions/CustomerSavedSearch"
}
},
"required": [
"customer_saved_search"
]
},
"CustomerSavedSearch": {
"title": "CustomerSavedSearch",
"example": {
"name": "Spent more than $50",
"query": "total_spent:>50"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Spent more than $50",
"type": "string"
},
"query": {
"description": "",
"example": "total_spent:>50",
"type": "string"
}
},
"required": [
"name",
"query"
]
},
"DeleteAnOrder.request": {
"title": "Delete an order.Request",
"example": {
"order": {
"customer": "null"
}
},
"type": "object",
"properties": {
"order": {
"$ref": "#/definitions/Order93"
}
},
"required": [
"order"
]
},
"Order93": {
"title": "Order93",
"example": {
"customer": null
},
"type": "object",
"properties": {
"customer": {
"description": "",
"type": "string"
}
},
"required": [
"customer"
]
},
"UpdateAnExistingRiskDetailLineOnAnOrderrequest": {
"title": "Update an existing risk detail line on an orderRequest",
"example": {
"risk": {
"id": 284138680,
"message": "After further review, this is a legitimate order",
"recommendation": "accept",
"source": "External",
"cause_cancel": false,
"score": 0.0
}
},
"type": "object",
"properties": {
"risk": {
"$ref": "#/definitions/Risk51"
}
},
"required": [
"risk"
]
},
"CaptureAPreviouslyAuthorizedOrderForTheFullAmountrequest": {
"title": "Capture a previously authorized order for the full amountRequest",
"example": {
"transaction": {
"kind": "capture"
}
},
"type": "object",
"properties": {
"transaction": {
"$ref": "#/definitions/Transaction"
}
},
"required": [
"transaction"
]
},
"Transaction": {
"title": "Transaction",
"example": {
"kind": "capture"
},
"type": "object",
"properties": {
"kind": {
"description": "",
"example": "capture",
"type": "string"
}
},
"required": [
"kind"
]
},
"Activate a oneTime chargerequest": {
"title": "Activate a one-time chargeRequest",
"example": {
"application_charge": {
"id": 675931192,
"name": "iPod Cleaning",
"api_client_id": 755357713,
"price": "5.00",
"status": "accepted",
"return_url": "http://google.com",
"created_at": "\"2017-01-05T20:31:41+00:00\"",
"updated_at": "\"2017-01-05T20:31:41+00:00\"",
"test": "null",
"charge_type": "null",
"decorated_return_url": "http://google.com?charge_id=675931192"
}
},
"type": "object",
"properties": {
"application_charge": {
"$ref": "#/definitions/ApplicationCharge"
}
},
"required": [
"application_charge"
]
},
"ApplicationCharge": {
"title": "ApplicationCharge",
"example": {
"id": 675931192,
"name": "iPod Cleaning",
"api_client_id": 755357713,
"price": "5.00",
"status": "accepted",
"return_url": "http://google.com",
"created_at": "2017-01-05T20:31:41+00:00",
"updated_at": "2017-01-05T20:31:41+00:00",
"test": null,
"charge_type": null,
"decorated_return_url": "http://google.com?charge_id=675931192"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 675931192,
"type": "integer",
"format": "int32"
},
"name": {
"description": "",
"example": "iPod Cleaning",
"type": "string"
},
"api_client_id": {
"description": "",
"example": 755357713,
"type": "integer",
"format": "int32"
},
"price": {
"description": "",
"example": "5.00",
"type": "string"
},
"status": {
"description": "",
"example": "accepted",
"type": "string"
},
"return_url": {
"description": "",
"example": "http://google.com",
"type": "string"
},
"created_at": {
"description": "",
"example": "1/5/2017 8:31:41 PM",
"type": "string"
},
"updated_at": {
"description": "",
"example": "1/5/2017 8:31:41 PM",
"type": "string"
},
"test": {
"description": "",
"type": "string"
},
"charge_type": {
"description": "",
"type": "string"
},
"decorated_return_url": {
"description": "",
"example": "http://google.com?charge_id=675931192",
"type": "string"
}
},
"required": [
"id",
"name",
"api_client_id",
"price",
"status",
"return_url",
"created_at",
"updated_at",
"test",
"charge_type",
"decorated_return_url"
]
},
"DisableADiscountrequest": {
"title": "Disable a discountRequest",
"example": {
"discount": {
"discount_type": "fixed_amount",
"value": "10.00",
"code": "fortunamajor",
"minimum_order_amount": "40.00"
}
},
"type": "object",
"properties": {
"discount": {
"$ref": "#/definitions/Discount"
}
},
"required": [
"discount"
]
},
"UpdateAnOrderrequest": {
"title": "Update an orderRequest",
"example": {
"order": {
"customer": "null"
}
},
"type": "object",
"properties": {
"order": {
"$ref": "#/definitions/Order93"
}
},
"required": [
"order"
]
},
"CreateANewProductImagerequest": {
"title": "Create a new product imageRequest",
"example": {
"image": {
"src": "http://example.com/rails_logo.gif"
}
},
"type": "object",
"properties": {
"image": {
"$ref": "#/definitions/Image"
}
},
"required": [
"image"
]
},
"UpdateACustomCollectionrequest": {
"title": "update a custom collectionRequest",
"example": {
"custom_collection": {
"id": 841564295,
"body_html": "<p>5000 songs in your pocket</p>"
}
},
"type": "object",
"properties": {
"custom_collection": {
"$ref": "#/definitions/CustomCollection107"
}
},
"required": [
"custom_collection"
]
},
"CustomCollection107": {
"title": "CustomCollection107",
"example": {
"id": 841564295,
"body_html": "<p>5000 songs in your pocket</p>"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 841564295,
"type": "integer",
"format": "int32"
},
"body_html": {
"description": "",
"example": "<p>5000 songs in your pocket</p>",
"type": "string"
}
},
"required": [
"id",
"body_html"
]
},
"CreateANewMetafieldForAProduct.request": {
"title": "Create a new metafield for a product.Request",
"example": {
"metafield": {
"namespace": "inventory",
"key": "warehouse",
"value": 25,
"value_type": "integer"
}
},
"type": "object",
"properties": {
"metafield": {
"$ref": "#/definitions/Metafield"
}
},
"required": [
"metafield"
]
},
"UpdateAnExistingCustomerSavedSearchrequest": {
"title": "Update an existing Customer Saved SearchRequest",
"example": {
"customer_saved_search": {
"id": 2029905294,
"name": "This Name Has Been Changed"
}
},
"type": "object",
"properties": {
"customer_saved_search": {
"$ref": "#/definitions/CustomerSavedSearch111"
}
},
"required": [
"customer_saved_search"
]
},
"CustomerSavedSearch111": {
"title": "CustomerSavedSearch111",
"example": {
"id": 2029905294,
"name": "This Name Has Been Changed"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 2029905294,
"type": "integer",
"format": "int32"
},
"name": {
"description": "",
"example": "This Name Has Been Changed",
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"Create a new oneTime application charge.request": {
"title": "Create a new one-time application charge.Request",
"example": {
"application_charge": {
"name": "Super Duper Expensive action",
"price": 100.0,
"return_url": "http://super-duper.shopifyapps.com"
}
},
"type": "object",
"properties": {
"application_charge": {
"$ref": "#/definitions/ApplicationCharge113"
}
},
"required": [
"application_charge"
]
},
"ApplicationCharge113": {
"title": "ApplicationCharge113",
"example": {
"name": "Super Duper Expensive action",
"price": 100.0,
"return_url": "http://super-duper.shopifyapps.com"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Super Duper Expensive action",
"type": "string"
},
"price": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"return_url": {
"description": "",
"example": "http://super-duper.shopifyapps.com",
"type": "string"
}
},
"required": [
"name",
"price",
"return_url"
]
},
"UpdateATheme'sAttributesrequest": {
"title": "Update a theme's attributesRequest",
"example": {
"theme": {
"id": 752253240,
"role": "main"
}
},
"type": "object",
"properties": {
"theme": {
"$ref": "#/definitions/Theme"
}
},
"required": [
"theme"
]
},
"Theme": {
"title": "Theme",
"example": {
"id": 752253240,
"role": "main"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 752253240,
"type": "integer",
"format": "int32"
},
"role": {
"description": "",
"example": "main",
"type": "string"
}
},
"required": [
"id",
"role"
]
},
"UpdateAScriptTagrequest": {
"title": "update a script tagRequest",
"example": {
"script_tag": {
"id": 596726825,
"src": "https://somewhere-else.com/another.js"
}
},
"type": "object",
"properties": {
"script_tag": {
"$ref": "#/definitions/ScriptTag117"
}
},
"required": [
"script_tag"
]
},
"ScriptTag117": {
"title": "ScriptTag117",
"example": {
"id": 596726825,
"src": "https://somewhere-else.com/another.js"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 596726825,
"type": "integer",
"format": "int32"
},
"src": {
"description": "",
"example": "https://somewhere-else.com/another.js",
"type": "string"
}
},
"required": [
"id",
"src"
]
},
"CreateANewChargerequest": {
"title": "Create a new chargeRequest",
"example": {
"recurring_application_charge": {
"name": "Super Duper Plan",
"price": 10.0,
"return_url": "http://super-duper.shopifyapps.com"
}
},
"type": "object",
"properties": {
"recurring_application_charge": {
"$ref": "#/definitions/RecurringApplicationCharge"
}
},
"required": [
"recurring_application_charge"
]
},
"RecurringApplicationCharge": {
"title": "RecurringApplicationCharge",
"example": {
"name": "Super Duper Plan",
"price": 10.0,
"return_url": "http://super-duper.shopifyapps.com"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Super Duper Plan",
"type": "string"
},
"price": {
"description": "",
"example": 10,
"type": "number",
"format": "double"
},
"return_url": {
"description": "",
"example": "http://super-duper.shopifyapps.com",
"type": "string"
}
},
"required": [
"name",
"price",
"return_url"
]
},
"DeleteAProductImagerequest": {
"title": "Delete a product imageRequest",
"example": {
"image": {
"id": 850703190,
"position": 2,
"metafields": [
{
"key": "alt",
"value": "new alt tag content",
"value_type": "string",
"namespace": "tags"
}
]
}
},
"type": "object",
"properties": {
"image": {
"$ref": "#/definitions/Image55"
}
},
"required": [
"image"
]
},
"DeleteAProductVariantrequest": {
"title": "Delete a product variantRequest",
"example": {
"page": {
"id": 131092082,
"published": true
}
},
"type": "object",
"properties": {
"page": {
"$ref": "#/definitions/Page"
}
},
"required": [
"page"
]
},
"UpdateAnExistingMetafieldBelongingToAProductrequest": {
"title": "Update an existing metafield belonging to a productRequest",
"example": {
"metafield": {
"id": 845366454,
"value": "titre",
"value_type": "string"
}
},
"type": "object",
"properties": {
"metafield": {
"$ref": "#/definitions/Metafield69"
}
},
"required": [
"metafield"
]
},
"CreateANewCustomerRecordrequest": {
"title": "Create a new customer recordRequest",
"example": {
"customer": {
"first_name": "Steve",
"last_name": "Lastnameson",
"email": "steve.lastnameson@example.com",
"phone": "+15142546011",
"verified_email": true,
"addresses": [
{
"address1": "123 Oak St",
"city": "Ottawa",
"province": "ON",
"phone": "555-1212",
"zip": "123 ABC",
"last_name": "Lastnameson",
"first_name": "Mother",
"country": "CA"
}
]
}
},
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer128"
}
},
"required": [
"customer"
]
},
"Customer128": {
"title": "Customer128",
"example": {
"first_name": "Steve",
"last_name": "Lastnameson",
"email": "steve.lastnameson@example.com",
"phone": "+15142546011",
"verified_email": true,
"addresses": [
{
"address1": "123 Oak St",
"city": "Ottawa",
"province": "ON",
"phone": "555-1212",
"zip": "123 ABC",
"last_name": "Lastnameson",
"first_name": "Mother",
"country": "CA"
}
]
},
"type": "object",
"properties": {
"first_name": {
"description": "",
"example": "Steve",
"type": "string"
},
"last_name": {
"description": "",
"example": "Lastnameson",
"type": "string"
},
"email": {
"description": "",
"example": "steve.lastnameson@example.com",
"type": "string"
},
"phone": {
"description": "",
"example": "+15142546011",
"type": "string"
},
"verified_email": {
"description": "",
"example": true,
"type": "boolean"
},
"addresses": {
"description": "",
"example": [
{
"address1": "123 Oak St",
"city": "Ottawa",
"province": "ON",
"phone": "555-1212",
"zip": "123 ABC",
"last_name": "Lastnameson",
"first_name": "Mother",
"country": "CA"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Address129"
}
}
},
"required": [
"first_name",
"last_name",
"email",
"phone",
"verified_email",
"addresses"
]
},
"Address129": {
"title": "Address129",
"example": {
"address1": "123 Oak St",
"city": "Ottawa",
"province": "ON",
"phone": "555-1212",
"zip": "123 ABC",
"last_name": "Lastnameson",
"first_name": "Mother",
"country": "CA"
},
"type": "object",
"properties": {
"address1": {
"description": "",
"example": "123 Oak St",
"type": "string"
},
"city": {
"description": "",
"example": "Ottawa",
"type": "string"
},
"province": {
"description": "",
"example": "ON",
"type": "string"
},
"phone": {
"description": "",
"example": "555-1212",
"type": "string"
},
"zip": {
"description": "",
"example": "123 ABC",
"type": "string"
},
"last_name": {
"description": "",
"example": "Lastnameson",
"type": "string"
},
"first_name": {
"description": "",
"example": "Mother",
"type": "string"
},
"country": {
"description": "",
"example": "CA",
"type": "string"
}
},
"required": [
"address1",
"city",
"province",
"phone",
"zip",
"last_name",
"first_name",
"country"
]
},
"UpdateAProvince'sTaxRaterequest": {
"title": "Update a province's tax rateRequest",
"example": {
"province": {
"id": 224293623,
"tax": 0.15
}
},
"type": "object",
"properties": {
"province": {
"$ref": "#/definitions/Province"
}
},
"required": [
"province"
]
},
"Province": {
"title": "Province",
"example": {
"id": 224293623,
"tax": 0.15
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 224293623,
"type": "integer",
"format": "int32"
},
"tax": {
"description": "",
"example": 0.15,
"type": "number",
"format": "double"
}
},
"required": [
"id",
"tax"
]
},
"DeleteAPagerequest": {
"title": "Delete a pageRequest",
"example": {
"page": {
"id": 131092082,
"published": true
}
},
"type": "object",
"properties": {
"page": {
"$ref": "#/definitions/Page"
}
},
"required": [
"page"
]
},
"CreateANewRefundForAnOrderrequest": {
"title": "Create a new refund for an orderRequest",
"example": {
"refund": {
"restock": true,
"notify": true,
"note": "wrong size",
"shipping": {
"full_refund": true
},
"refund_line_items": [
{
"line_item_id": 518995019,
"quantity": 1
}
],
"transactions": [
{
"parent_id": 801038806,
"amount": 199.65,
"kind": "refund",
"gateway": "bogus"
}
]
}
},
"type": "object",
"properties": {
"refund": {
"$ref": "#/definitions/Refund135"
}
},
"required": [
"refund"
]
},
"Refund135": {
"title": "Refund135",
"example": {
"restock": true,
"notify": true,
"note": "wrong size",
"shipping": {
"full_refund": true
},
"refund_line_items": [
{
"line_item_id": 518995019,
"quantity": 1
}
],
"transactions": [
{
"parent_id": 801038806,
"amount": 199.65,
"kind": "refund",
"gateway": "bogus"
}
]
},
"type": "object",
"properties": {
"restock": {
"description": "",
"example": true,
"type": "boolean"
},
"notify": {
"description": "",
"example": true,
"type": "boolean"
},
"note": {
"description": "",
"example": "wrong size",
"type": "string"
},
"shipping": {
"$ref": "#/definitions/Shipping"
},
"refund_line_items": {
"description": "",
"example": [
{
"line_item_id": 518995019,
"quantity": 1
}
],
"type": "array",
"items": {
"$ref": "#/definitions/RefundLineItem137"
}
},
"transactions": {
"description": "",
"example": [
{
"parent_id": 801038806,
"amount": 199.65,
"kind": "refund",
"gateway": "bogus"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Transaction138"
}
}
},
"required": [
"restock",
"notify",
"note",
"shipping",
"refund_line_items",
"transactions"
]
},
"RefundLineItem137": {
"title": "RefundLineItem137",
"example": {
"line_item_id": 518995019,
"quantity": 1
},
"type": "object",
"properties": {
"line_item_id": {
"description": "",
"example": 518995019,
"type": "integer",
"format": "int32"
},
"quantity": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
}
},
"required": [
"line_item_id",
"quantity"
]
},
"Transaction138": {
"title": "Transaction138",
"example": {
"parent_id": 801038806,
"amount": 199.65,
"kind": "refund",
"gateway": "bogus"
},
"type": "object",
"properties": {
"parent_id": {
"description": "",
"example": 801038806,
"type": "integer",
"format": "int32"
},
"amount": {
"description": "",
"example": 199.65,
"type": "number",
"format": "double"
},
"kind": {
"description": "",
"example": "refund",
"type": "string"
},
"gateway": {
"description": "",
"example": "bogus",
"type": "string"
}
},
"required": [
"parent_id",
"amount",
"kind",
"gateway"
]
},
"AddAProductToACollectionrequest": {
"title": "Add a product to a collectionRequest",
"example": {
"collect": {
"product_id": 921728736,
"collection_id": 841564295
}
},
"type": "object",
"properties": {
"collect": {
"$ref": "#/definitions/Collect"
}
},
"required": [
"collect"
]
},
"Collect": {
"title": "Collect",
"example": {
"product_id": 921728736,
"collection_id": 841564295
},
"type": "object",
"properties": {
"product_id": {
"description": "",
"example": 921728736,
"type": "integer",
"format": "int32"
},
"collection_id": {
"description": "",
"example": 841564295,
"type": "integer",
"format": "int32"
}
},
"required": [
"product_id",
"collection_id"
]
},
"DestroyACarrierServicerequest": {
"title": "Destroy a carrier serviceRequest",
"example": {
"carrier_service": {
"name": "Shipping Rate Provider",
"callback_url": "http://shippingrateprovider.com",
"service_discovery": true
}
},
"type": "object",
"properties": {
"carrier_service": {
"$ref": "#/definitions/CarrierService"
}
},
"required": [
"carrier_service"
]
},
"CreateANewProductWithMultipleProductVariantsrequest": {
"title": "Create a new product with multiple product variantsRequest",
"example": {
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"variants": [
{
"option1": "First",
"price": "10.00",
"sku": 123
},
{
"option1": "Second",
"price": "20.00",
"sku": 123
}
]
}
},
"type": "object",
"properties": {
"product": {
"$ref": "#/definitions/Product144"
}
},
"required": [
"product"
]
},
"Product144": {
"title": "Product144",
"example": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"variants": [
{
"option1": "First",
"price": "10.00",
"sku": 123
},
{
"option1": "Second",
"price": "20.00",
"sku": 123
}
]
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Burton Custom Freestyle 151",
"type": "string"
},
"body_html": {
"description": "",
"example": "<strong>Good snowboard!</strong>",
"type": "string"
},
"vendor": {
"description": "",
"example": "Burton",
"type": "string"
},
"product_type": {
"description": "",
"example": "Snowboard",
"type": "string"
},
"variants": {
"description": "",
"example": [
{
"option1": "First",
"price": "10.00",
"sku": 123
},
{
"option1": "Second",
"price": "20.00",
"sku": 123
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Variant145"
}
}
},
"required": [
"title",
"body_html",
"vendor",
"product_type",
"variants"
]
},
"Variant145": {
"title": "Variant145",
"example": {
"option1": "First",
"price": "10.00",
"sku": 123
},
"type": "object",
"properties": {
"option1": {
"description": "",
"example": "First",
"type": "string"
},
"price": {
"description": "",
"example": "10.00",
"type": "string"
},
"sku": {
"description": "",
"example": 123,
"type": "integer",
"format": "int32"
}
},
"required": [
"option1",
"price",
"sku"
]
},
"UpdateABlogrequest": {
"title": "Update a blogRequest",
"example": {
"blog": {
"metafields": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
]
}
},
"type": "object",
"properties": {
"blog": {
"$ref": "#/definitions/Blog147"
}
},
"required": [
"blog"
]
},
"Blog147": {
"title": "Blog147",
"example": {
"metafields": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
]
},
"type": "object",
"properties": {
"metafields": {
"description": "",
"example": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Metafield56"
}
}
},
"required": [
"metafields"
]
},
"ChangeAnExistingLiquidTemplate'sValuerequest": {
"title": "Change an existing liquid template's valueRequest",
"example": {
"asset": {
"key": "templates/index.liquid",
"value": "<img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>"
}
},
"type": "object",
"properties": {
"asset": {
"$ref": "#/definitions/Asset"
}
},
"required": [
"asset"
]
},
"Asset": {
"title": "Asset",
"example": {
"key": "templates/index.liquid",
"value": "<img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>"
},
"type": "object",
"properties": {
"key": {
"description": "",
"example": "templates/index.liquid",
"type": "string"
},
"value": {
"description": "",
"example": "<img src='backsoon-postit.png'><p>We are busy updating the store for you and will be back within the hour.</p>",
"type": "string"
}
},
"required": [
"key",
"value"
]
},
"CreatingANewAddressForACustomerrequest": {
"title": "Creating a new address for a customerRequest",
"example": {
"address": {
"address1": "1 Rue des Carrieres",
"address2": "Suite 1234",
"city": "Montreal",
"company": "Fancy Co.",
"first_name": "Samuel",
"last_name": "de Champlain",
"phone": "819-555-5555",
"province": "Quebec",
"country": "Canada",
"zip": "G1R 4P5",
"name": "Samuel de Champlain",
"province_code": "QC",
"country_code": "CA",
"country_name": "Canada"
}
},
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/Address152"
}
},
"required": [
"address"
]
},
"Address152": {
"title": "Address152",
"example": {
"address1": "1 Rue des Carrieres",
"address2": "Suite 1234",
"city": "Montreal",
"company": "Fancy Co.",
"first_name": "Samuel",
"last_name": "de Champlain",
"phone": "819-555-5555",
"province": "Quebec",
"country": "Canada",
"zip": "G1R 4P5",
"name": "Samuel de Champlain",
"province_code": "QC",
"country_code": "CA",
"country_name": "Canada"
},
"type": "object",
"properties": {
"address1": {
"description": "",
"example": "1 Rue des Carrieres",
"type": "string"
},
"address2": {
"description": "",
"example": "Suite 1234",
"type": "string"
},
"city": {
"description": "",
"example": "Montreal",
"type": "string"
},
"company": {
"description": "",
"example": "Fancy Co.",
"type": "string"
},
"first_name": {
"description": "",
"example": "Samuel",
"type": "string"
},
"last_name": {
"description": "",
"example": "de Champlain",
"type": "string"
},
"phone": {
"description": "",
"example": "819-555-5555",
"type": "string"
},
"province": {
"description": "",
"example": "Quebec",
"type": "string"
},
"country": {
"description": "",
"example": "Canada",
"type": "string"
},
"zip": {
"description": "",
"example": "G1R 4P5",
"type": "string"
},
"name": {
"description": "",
"example": "Samuel de Champlain",
"type": "string"
},
"province_code": {
"description": "",
"example": "QC",
"type": "string"
},
"country_code": {
"description": "",
"example": "CA",
"type": "string"
},
"country_name": {
"description": "",
"example": "Canada",
"type": "string"
}
},
"required": [
"address1",
"address2",
"city",
"company",
"first_name",
"last_name",
"phone",
"province",
"country",
"zip",
"name",
"province_code",
"country_code",
"country_name"
]
},
"CreateANewThemerequest": {
"title": "Create a new themeRequest",
"example": {
"theme": {
"name": "Lemongrass",
"src": "http://themes.shopify.com/theme.zip",
"role": "main"
}
},
"type": "object",
"properties": {
"theme": {
"$ref": "#/definitions/Theme154"
}
},
"required": [
"theme"
]
},
"Theme154": {
"title": "Theme154",
"example": {
"name": "Lemongrass",
"src": "http://themes.shopify.com/theme.zip",
"role": "main"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Lemongrass",
"type": "string"
},
"src": {
"description": "",
"example": "http://themes.shopify.com/theme.zip",
"type": "string"
},
"role": {
"description": "",
"example": "main",
"type": "string"
}
},
"required": [
"name",
"src",
"role"
]
},
"UpdateARedirectrequest": {
"title": "Update a redirectRequest",
"example": {
"redirect": {
"id": 668809255,
"path": "/tiger"
}
},
"type": "object",
"properties": {
"redirect": {
"$ref": "#/definitions/Redirect156"
}
},
"required": [
"redirect"
]
},
"Redirect156": {
"title": "Redirect156",
"example": {
"id": 668809255,
"path": "/tiger"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 668809255,
"type": "integer",
"format": "int32"
},
"path": {
"description": "",
"example": "/tiger",
"type": "string"
}
},
"required": [
"id",
"path"
]
},
"CreateANewProductVariantrequest": {
"title": "Create a new product variantRequest",
"example": {
"variant": {
"option1": "Yellow",
"price": "1.00"
}
},
"type": "object",
"properties": {
"variant": {
"$ref": "#/definitions/Variant158"
}
},
"required": [
"variant"
]
},
"Variant158": {
"title": "Variant158",
"example": {
"option1": "Yellow",
"price": "1.00"
},
"type": "object",
"properties": {
"option1": {
"description": "",
"example": "Yellow",
"type": "string"
},
"price": {
"description": "",
"example": "1.00",
"type": "string"
}
},
"required": [
"option1",
"price"
]
},
"EnableADiscountrequest": {
"title": "Enable a discountRequest",
"example": {
"discount": {
"discount_type": "fixed_amount",
"value": "10.00",
"code": "fortunamajor",
"minimum_order_amount": "40.00"
}
},
"type": "object",
"properties": {
"discount": {
"$ref": "#/definitions/Discount"
}
},
"required": [
"discount"
]
}
}
}
@jbeaven
Copy link

jbeaven commented Feb 3, 2019

Hi Kin, how did you generate this? I notice the response definitions are missing - do you have a more recent version? Cheers

@ssapa
Copy link

ssapa commented Mar 1, 2021

Hi Kin.. How did you generate this? Can you help me with most recent versions if you have any?

@kinlane
Copy link
Author

kinlane commented Mar 1, 2021

This is the latest one I have - https://www.postman.com/api-evangelist/workspace/shopify/overview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment