json Moltin OpenAPI
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了json Moltin OpenAPI相关的知识，希望对你有一定的参考价值。
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Moltin",
"description": "## Welcome\n\nThis is a place to put general notes and extra information, for internal use.\n\nTo get started designing/documenting this API, select a version on the left."
},
"host": "api.moltin.com",
"basePath": "/",
"securityDefinitions": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://api.moltin.com",
"scopes": {},
"x-skip-client-authentication": false
}
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v2/customers/{customerID}/addresses/{addressID}": {
"get": {
"description": "",
"summary": "Get an Address",
"tags": [
"Addresses"
],
"operationId": "V2CustomersAddressesByCustomerIDAndAddressIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "addressID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update an Address",
"tags": [
"Addresses"
],
"operationId": "V2CustomersAddressesByCustomerIDAndAddressIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "addressID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete an Address",
"tags": [
"Addresses"
],
"operationId": "V2CustomersAddressesByCustomerIDAndAddressIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "addressID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/promotions/{promotionID}/codes": {
"get": {
"description": "",
"summary": "Get a list of promotion codes",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsCodesByPromotionIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "promotionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create promotion codes",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsCodesByPromotionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreatePromotionCodesrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "promotionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/customers/{customerID}/addresses": {
"get": {
"description": "",
"summary": "Get an list of Addresses",
"tags": [
"Addresses"
],
"operationId": "V2CustomersAddressesByCustomerIDGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create an Address",
"tags": [
"Addresses"
],
"operationId": "V2CustomersAddressesByCustomerIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAnAddressrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": true,
"type": "string",
"description": "Change from default currency"
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": "Change default locale"
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/{integrationID}": {
"get": {
"description": "",
"summary": "Get an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsByIntegrationIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsByIntegrationIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnIntegrationrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsByIntegrationIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/{brandID}": {
"get": {
"description": "",
"summary": "Get a Brand",
"tags": [
"Brands"
],
"operationId": "V2BrandsByBrandIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "include",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Brand",
"tags": [
"Brands"
],
"operationId": "V2BrandsByBrandIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateABrandrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Brand",
"tags": [
"Brands"
],
"operationId": "V2BrandsByBrandIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows": {
"get": {
"description": "",
"summary": "Get all flows",
"tags": [
"Flows"
],
"operationId": "V2FlowsGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/flows",
"headers": {
"Accept": "application/json",
"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 flows",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAFlowrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/flows",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"flow\",\"name\":\"Products\",\"slug\":\"products\",\"description\":\"Extends the default product object\",\"enabled\":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 flow",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/customers/{customerID}": {
"get": {
"description": "",
"summary": "Get a Customer",
"tags": [
"Customers"
],
"operationId": "V2CustomersByCustomerIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": true,
"type": "string",
"description": "A customer token"
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Customer",
"tags": [
"Customers"
],
"operationId": "V2CustomersByCustomerIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACustomerrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Deletes a customer.",
"summary": "Delete a Customer",
"tags": [
"Customers"
],
"operationId": "V2CustomersByCustomerIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowSlug}/entries/{entryID}": {
"get": {
"description": "",
"summary": "Get an entry",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesByFlowSlugAndEntryIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "entryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update an entry",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesByFlowSlugAndEntryIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnEntryrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "entryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete an entry",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesByFlowSlugAndEntryIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "entryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/orders/{orderID}": {
"get": {
"description": "",
"summary": "Get a single order",
"tags": [
"Orders"
],
"operationId": "V2OrdersByOrderIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "orderID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Transactions are created and updated automatically whenever you make a payment request. When a payment is successful, the transaction ID returned from the gateway will be attached to the transaction.\n\nIt is possible for an order to have more than one transaction attached as each attempted payment will be created as a new transaction.",
"summary": "Update an order",
"tags": [
"Orders"
],
"operationId": "V2OrdersByOrderIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnOrderrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "orderID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/relationships/variations": {
"put": {
"description": "`Product Variation`'s specified in the payload willbe related to the `Product` any relatiosnhips to `Product Variation`'s **NOT** specified in payload will be removed.",
"summary": "Update Product <=> Variations Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsVariationsByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Here you can add and remove `Product Variation`'s to a product. `Product Variation`'s specified in the payload willbe related to the product.",
"summary": "Create Product <=> Variations Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsVariationsByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can add and remove `Product Variation`'s to a product. Only relationships to `Product Variation`'s specified in the payload will be removed.",
"summary": "Delete Product <=> Variations Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsVariationsByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/{brandID}/relationships/parent": {
"put": {
"description": "",
"summary": "Update Parent Brand Relationship",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsParentByBrandIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateParentBrandRelationshiprequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create Parent Brand Relationship",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsParentByBrandIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateParentBrandRelationshiprequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete Parent Brand Relationship",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsParentByBrandIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/promotions/{promotionID}": {
"get": {
"description": "",
"summary": "Get a promotion",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsByPromotionIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "promotionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update promotion",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsByPromotionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdatePromotionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "promotionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete Promotion",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsByPromotionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeletePromotionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "promotionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/{CART_REFERENCE} ": {
"delete": {
"description": "Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.",
"summary": "Delete Cart",
"tags": [
"Carts"
],
"operationId": "V2CartsByCARTREFERENCEDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "CART_REFERENCE",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/settings": {
"get": {
"description": "",
"summary": "Get Settings Attributes",
"tags": [
"Settings"
],
"operationId": "V2SettingsGet2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/settings",
"headers": {
"Accept": "application/json",
"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 Settings Attributes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update Settings",
"tags": [
"Settings"
],
"operationId": "V2SettingsPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateSettingsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/v2/settings",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"settings\",\"page_length\":70,\"list_child_products\":false,\"additional_languages\":[\"es\",\"fr\",\"de\"]}}"
},
"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 Settings",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/{categoryID}": {
"get": {
"description": "",
"summary": "Get a Category",
"tags": [
"Categories"
],
"operationId": "V2CategoriesByCategoryIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Category",
"tags": [
"Categories"
],
"operationId": "V2CategoriesByCategoryIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACategoryrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Category",
"tags": [
"Categories"
],
"operationId": "V2CategoriesByCategoryIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/123456/items": {
"get": {
"description": "",
"summary": "Get the items in a cart",
"tags": [
"Carts"
],
"operationId": "V2Carts123456ItemsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/carts/123456/items",
"headers": {
"Accept": "application/json",
"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 items in a cart",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.",
"summary": "Add a promotion to a cart",
"tags": [
"Carts"
],
"operationId": "V2Carts123456ItemsPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/carts/123456/items",
"headers": {
"Accept": "application/json",
"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": "Add a promotion to a cart",
"x-testDescription": "Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/relationships/files": {
"put": {
"description": "`File`'s specified in the payload willbe related to the product any relatiosnhips to `File`'s **NOT** specified in payload will be removed.",
"summary": "Update Products <=> Files Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsFilesByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProducts<=>FilesRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Here you can add `File`'s to a product. `File`'s specified in the payload willbe related to the product.",
"summary": "Create Products <=> Files Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsFilesByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProducts<=>FilesRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can delete a relationship between a `Product` and `File`'s. Only relationships to `File`'s specified in the payload will be removed.",
"summary": "Delete Products <=> Files Relationship",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsFilesByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteProducts<=>FilesRelationshiprequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/attributes": {
"get": {
"summary": "Get Integration Attributes",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsAttributesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/integrations/attributes",
"headers": {
"Accept": "application/json",
"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 Integration Attributes"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/gateways/braintree": {
"put": {
"description": "This endpoint allows you to pay for an order using Braintree and a users credit card.",
"summary": "Braintree - Update",
"tags": [
"Gateways"
],
"operationId": "V2GatewaysBraintreePut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Braintree updaterequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/v2/gateways/braintree",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"enabled\":true,\"environment\":\"production\",\"merchant_id\":\"xxx\",\"private_key\":\"xxx\",\"public_key\":\"xxx\"}}"
},
"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": "Braintree - Update",
"x-testDescription": "This endpoint allows you to pay for an order using Braintree and a users credit card."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections/{collectionID}/relationships/collections": {
"post": {
"summary": "Create Collection Relationships",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsCollectionsByCollectionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateCollectionRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/{integrationID}/logs": {
"get": {
"description": "",
"summary": "Get Logs for an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsLogsByIntegrationIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/{categoryID}/relationships/children": {
"put": {
"description": "",
"summary": "Update Child Category Relationships",
"tags": [
"Categories"
],
"operationId": "V2CategoriesRelationshipsChildrenByCategoryIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateChildCategoryRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete Child Category Relationships",
"tags": [
"Categories"
],
"operationId": "V2CategoriesRelationshipsChildrenByCategoryIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteChildCategoryRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections": {
"get": {
"description": "",
"summary": "Get Collections List",
"tags": [
"Collections"
],
"operationId": "V2CollectionsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/collections",
"headers": {
"Accept": "application/json",
"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 Collections List",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"summary": "Create a Collection",
"tags": [
"Collections"
],
"operationId": "V2CollectionsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACollectionrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/collections",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"collection\",\"name\":\"Winter Season\",\"slug\":\"winter-season\",\"description\":\"Our Winter Season is now live!\",\"status\":\"live\"}}"
},
"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 Collection"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/{categoryID}/relationships/children": {
"post": {
"description": "",
"summary": "Create Child Category Relationships",
"tags": [
"Categories"
],
"operationId": "CategoriesRelationshipsChildrenByCategoryIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateChildCategoryRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/123456": {
"get": {
"description": "",
"summary": "Get a Cart",
"tags": [
"Carts"
],
"operationId": "V2Carts123456Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/carts/123456",
"headers": {
"Accept": "application/json",
"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 Cart",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections/{collectionID}": {
"get": {
"description": "",
"summary": "Get a Collection",
"tags": [
"Collections"
],
"operationId": "V2CollectionsByCollectionIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "page[limit]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "sort",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "filter",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "include",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"summary": "Update a Collection",
"tags": [
"Collections"
],
"operationId": "V2CollectionsByCollectionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACollectionrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"summary": "Delete a Collection",
"tags": [
"Collections"
],
"operationId": "V2CollectionsByCollectionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/inventories ": {
"get": {
"description": "",
"summary": "Get all stock",
"tags": [
"Inventory"
],
"operationId": "V2InventoriesGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/inventories "
},
"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 stock",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowID}": {
"get": {
"description": "",
"summary": "Get a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsByFlowIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsByFlowIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAFlowrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsByFlowIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/gateways/adyen": {
"put": {
"description": "This endpoint allows you to pay for an order using Braintree and a users credit card.",
"summary": "Adyen - Card Update",
"tags": [
"Gateways"
],
"operationId": "V2GatewaysAdyenPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Adyen card updaterequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/v2/gateways/adyen",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"enabled\":true,\"merchant_account\":\"xxx\",\"password\":\"xxx\",\"test\":false,\"username\":\"xxx\"}}"
},
"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": "Adyen - Card Update",
"x-testDescription": "This endpoint allows you to pay for an order using Braintree and a users credit card."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/123456/items/{itemID}": {
"put": {
"description": "Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.",
"summary": "Update an item in a cart",
"tags": [
"Carts"
],
"operationId": "V2Carts123456ItemsByItemIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnItemInACartrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "itemID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowSlug}/entries/{ENTRY_ID}/relationships/{flowSlug}": {
"put": {
"description": "",
"summary": "Update Entry Relationship(s)",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesRelationshipsFlowSlugByFlowSlugAndENTRYIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateEntryRelationship(s)request"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "ENTRY_ID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"summary": "Delete Entry Relationship(s)",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesRelationshipsFlowSlugByFlowSlugAndENTRYIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteEntryRelationship(s)request"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "ENTRY_ID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/inventories/{productID}/transactions": {
"get": {
"summary": "Stock transactions for a product",
"tags": [
"Inventory"
],
"operationId": "V2InventoriesTransactionsByProductIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a stock transaction for a product",
"tags": [
"Inventory"
],
"operationId": "V2InventoriesTransactionsByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAStockTransactionForAProductrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/{CategoryID}/relationships/children": {
"post": {
"description": "",
"summary": "Create Category-Category Relationships",
"tags": [
"Checkout"
],
"operationId": "CategoriesRelationshipsChildrenByCategoryIDPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Create categoryCategory relationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "CategoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}": {
"get": {
"description": "",
"summary": "Get a Product",
"tags": [
"Products"
],
"operationId": "V2ProductsByProductIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Product",
"tags": [
"Products"
],
"operationId": "V2ProductsByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Product",
"tags": [
"Products"
],
"operationId": "V2ProductsByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/relationships/brands": {
"put": {
"description": "Here you can set relations `Brand`'s to a product. The result of this request will set relationships between product and the specified brnads in teh payload and remove any other relations the product had with brands.",
"summary": "Update Product <=> Brands Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsBrandsByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProduct<=>BrandsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Here you can add `Brand`'s to a product. The `Brand`'s found in the payload will be added to any other relationships to `Brand`'s present.",
"summary": "Create Product <=> Brands Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsBrandsByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProduct<=>BrandsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can delete a relationship between a `Product` and `Brand`'s. Only those relationshops to `Brand`'s specified in the paylaod will be removed.",
"summary": "Delete Products <=> Brands Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsBrandsByProductIDDelete2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteProducts<=>BrandsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/files/{fileID}": {
"get": {
"description": "",
"summary": "Get a file",
"tags": [
"Files"
],
"operationId": "V2FilesByFileIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fileID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a file",
"tags": [
"Files"
],
"operationId": "V2FilesByFileIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fileID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/fields": {
"get": {
"description": "",
"summary": "Get a field list",
"tags": [
"Flows"
],
"operationId": "V2FieldsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/fields",
"headers": {
"Accept": "application/json",
"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 field list",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a field",
"tags": [
"Flows"
],
"operationId": "V2FieldsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAFieldrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/fields",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"field\",\"name\":\"Product Rating\",\"slug\":\"product-rating\",\"field_type\":\"integer\",\"validation_rules\":[{\"type\":\"between\",\"options\":{\"from\":1,\"to\":5}}],\"description\":\"Average rating as given by our users\",\"required\":false,\"unique\":false,\"default\":0,\"enabled\":true,\"order\":1,\"relationships\":{\"flow\":{\"data\":{\"type\":\"flow\",\"id\":\"{{flowID}}\"}}}}}"
},
"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 field",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/{brandID}/relationships/children": {
"put": {
"description": "",
"summary": "Update Child Brand Relationship",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsChildrenByBrandIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateChildBrandRelationshiprequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create Child Brand Relationship",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsChildrenByBrandIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateChildBrandRelationshiprequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Update Child Brand Relationship Copy",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsChildrenByBrandIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections/{collectionID}/relationships/parent": {
"put": {
"summary": "Update Parent Collection Relationship",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsParentByCollectionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateParentCollectionRelationshiprequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"summary": "Create Parent Collection Relationship",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsParentByCollectionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateParentCollectionRelationshiprequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"summary": "Delete Parent Collection Relationship",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsParentByCollectionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations/{variationID}": {
"get": {
"description": "",
"summary": "Get a Product Variation",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsByVariationIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Product Variation",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsByVariationIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductVariationrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Product Variation",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsByVariationIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/customers": {
"get": {
"summary": "Get Customers List",
"tags": [
"Customers"
],
"operationId": "V2CustomersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "page[limit]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "sort",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "filter",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/customers?page[offset]=0&page[limit]=10&sort={{sort}}&filter={{filter}}",
"headers": {
"Accept": "application/json",
"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 Customers List"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a Customer",
"tags": [
"Customers"
],
"operationId": "V2CustomersPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACustomerrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/customers",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"customer\",\"name\":\"Ron Swanson+5\",\"email\":\"ron+5@swanson.com\",\"password\":\"mysecretpassword\"}}"
},
"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 Customer",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/build": {
"post": {
"description": "",
"summary": "Build Child Products",
"tags": [
"Products"
],
"operationId": "V2ProductsBuildByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/oauth/access_token": {
"post": {
"description": "An access token will allow you to make requests for your store. We support two types of token: `client_credentials` and `implicit`.\n\nAn `implcit` token is typically used for situations where you are requesting data on the client side and you are exposing your public key - such as JavaScript - and adding your client secret would be disastrous. You will only be able to perform a limited number of operations on the API endpoints.\n\nA `client_credentials` token is used when the credentials are not publicly exposed, usually a server side language such as PHP. You will be able to perform all operations on API endpoints.\n\nA `refresh_token` type can be used when you have an existing token which you would like to extend the life of. When your `grant_type` is `refresh_token` you must also provide the original token in the `refresh_token` field.",
"summary": "Client credential token",
"tags": [
"Authentication"
],
"operationId": "OauthAccessTokenPost2",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "client_id",
"in": "formData",
"required": true,
"type": "string",
"description": "Replace with the values from your dashboard"
},
{
"name": "client_secret",
"in": "formData",
"required": true,
"type": "string",
"description": "Replace with the values from your dashboard"
},
{
"name": "grant_type",
"in": "formData",
"required": true,
"type": "string",
"description": "client_credentials | implicit | refresh_token"
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/oauth/access_token",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json"
},
"body": "client_id=&client_secret=&grant_type=client_credentials"
},
"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": "Client credential token",
"x-testDescription": "An access token will allow you to make requests for your store. We support two types of token: `client_credentials` and `implicit`.\n\nAn `implcit` token is typically used for situations where you are requesting data on the client side and you are exposing your public key - such as JavaScript - and adding your client secret would be disastrous. You will only be able to perform a limited number of operations on the API endpoints.\n\nA `client_credentials` token is used when the credentials are not publicly exposed, usually a server side language such as PHP. You will be able to perform all operations on API endpoints.\n\nA `refresh_token` type can be used when you have an existing token which you would like to extend the life of. When your `grant_type` is `refresh_token` you must also provide the original token in the `refresh_token` field."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections/tree": {
"get": {
"summary": "Get Collection tree",
"tags": [
"Collections"
],
"operationId": "V2CollectionsTreeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/collections/tree",
"headers": {
"Accept": "application/json",
"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 Collection tree"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{ProductID}relationships/brands": {
"post": {
"description": "Here you can add a `Main Image` to a product. The `Main Image` will be a file and that file will be shown as the first image for the product it is related to.\n\nIt's worth noting that you can only have 1 main image so unlike other relationships, you will be passing an object instead of an array in the body.\n\nIn the Object, the type will be `main_image` and the ID will be the ID of the file you wish to make the main image for that product.",
"summary": "Create Products <=> Main Image Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsBrandsByProductIDPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProducts<=>MainImageRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "ProductID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can delete the `Main Image` from a product.\n\nIn the Object payload, the type will be `main_image` and the ID will be the ID of the main image you wish to delete from that product.",
"summary": "Delete Products <=> Main Image Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsBrandsByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "ProductID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowSlug}/entries": {
"get": {
"description": "",
"summary": "Get all entries on a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesByFlowSlugGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create an entry",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesByFlowSlugPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAnEntryrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/fields/{fieldID}": {
"get": {
"description": "",
"summary": "Get a field",
"tags": [
"Flows"
],
"operationId": "V2FieldsByFieldIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fieldID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a field",
"tags": [
"Flows"
],
"operationId": "V2FieldsByFieldIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAFieldrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fieldID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a field",
"tags": [
"Flows"
],
"operationId": "V2FieldsByFieldIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fieldID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/123456/checkout": {
"post": {
"description": "Converts a cart to an incomplete order. The original cart will remain and can be modified and checked out again if required.\n\nThe new order will be returned and `data.meta.payment_gateways` will contain an array of the available payment gateways for this order.",
"summary": "Checkout using customer id",
"tags": [
"Checkout"
],
"operationId": "V2Carts123456CheckoutPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CheckoutUsingCustomerIdrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/carts/123456/checkout",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"customer\":{\"id\":\"{{customerID}}\"},\"billing_address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"company_name\":\"Moltin\",\"line_1\":\"2nd Floor British India House\",\"line_2\":\"15 Carliol Square\",\"city\":\"Newcastle upon Tyne\",\"postcode\":\"NE1 6UF\",\"county\":\"Tyne & Wear\",\"country\":\"UK\"},\"shipping_address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"phone_number\":\"(555) 555-1234\",\"company_name\":\"Moltin\",\"line_1\":\"2nd Floor British India House\",\"line_2\":\"15 Carliol Square\",\"city\":\"Newcastle upon Tyne\",\"postcode\":\"NE1 6UF\",\"county\":\"Tyne & Wear\",\"country\":\"UK\",\"instructions\":\"Leave in porch\"}}}"
},
"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": "Checkout using customer id",
"x-testDescription": "Converts a cart to an incomplete order. The original cart will remain and can be modified and checked out again if required.\n\nThe new order will be returned and `data.meta.payment_gateways` will contain an array of the available payment gateways for this order."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/relationships/categories": {
"put": {
"description": "Here you can update `Categories` to a product. `Categories` specified in the payload willbe related to the product any relatiosnhips to `Categories` **NOT** specified in payload will be removed.",
"summary": "Update Product <=> Categories Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCategoriesByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Here you can add `Categories` to a product. `Categories` specified in the payload willbe related to the product.",
"summary": "Create Product <=> Categories Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCategoriesByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProduct<=>CategoriesRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can delete a relationship between a `Product` and `Category`. Only relationships to `Categories` specified in the payload will be removed.",
"summary": "Delete Product <=> Categories Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCategoriesByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteProduct<=>CategoriesRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations": {
"get": {
"description": "",
"summary": "Get Product Variations List",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/variations",
"headers": {
"Accept": "application/json",
"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 Product Variations List",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a Product Variation",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAProductVariationrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/variations",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"product-variation\",\"name\":\"Paint colour\"}}"
},
"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 Product Variation",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/tree": {
"get": {
"description": "",
"summary": "Get a Brand tree",
"tags": [
"Brands"
],
"operationId": "V2BrandsTreeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/brands/tree",
"headers": {
"Accept": "application/json",
"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 Brand tree",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowSlug}/fields": {
"get": {
"description": "",
"summary": "Get all fields on a flow",
"tags": [
"Flows"
],
"operationId": "V2FlowsFieldsByFlowSlugGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/currencies": {
"get": {
"description": "",
"summary": "Get Currencies List",
"tags": [
"Currencies"
],
"operationId": "V2CurrenciesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/currencies",
"headers": {
"Accept": "application/json",
"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 Currencies List",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a Currency",
"tags": [
"Currencies"
],
"operationId": "V2CurrenciesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACurrencyrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/currencies",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"currency\",\"code\":\"GBP\",\"exchange_rate\":1,\"format\":\"£{price}\",\"decimal_point\":\".\",\"thousand_separator\":\",\",\"decimal_places\":2,\"default\":false,\"enabled\":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 Currency",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/relationships/collections": {
"put": {
"description": "`Collection`'s specified in the payload willbe related to the product any relatiosnhips to `Collection`'s **NOT** specified in payload will be removed.",
"summary": "Update Products <=> Collections Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCollectionsByProductIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProducts<=>CollectionsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Here you can add `Collection`'s to a product. `Collection`'s specified in the payload willbe related to the product.",
"summary": "Create Products <=> Collections Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCollectionsByProductIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProducts<=>CollectionsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Here you can delete a relationship between a `Product` and `Collections`. Only relationships to `Collections` specified in the payload will be removed.",
"summary": "Delete Products <=> Collections Relationships",
"tags": [
"Product Relationships"
],
"operationId": "V2ProductsRelationshipsCollectionsByProductIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeleteProducts<=>CollectionsRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/currencies/{currencyID}": {
"get": {
"description": "",
"summary": "Get a Currency",
"tags": [
"Currencies"
],
"operationId": "V2CurrenciesByCurrencyIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "currencyID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a Currency",
"tags": [
"Currencies"
],
"operationId": "V2CurrenciesByCurrencyIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACurrencyrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "currencyID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Currency",
"tags": [
"Currencies"
],
"operationId": "V2CurrenciesByCurrencyIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "currencyID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations/{variationID}/options/{optionID}": {
"put": {
"description": "",
"summary": "Update a Product Variation Option",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsByVariationIDAndOptionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductVariationOptionrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "optionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a Product Variation Option",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsByVariationIDAndOptionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "optionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/{parentCatID}/relationships/parent": {
"put": {
"description": "",
"summary": "Update Parent Category Parent",
"tags": [
"Categories"
],
"operationId": "V2CategoriesRelationshipsParentByParentCatIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateParentCategoryParentrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "parentCatID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/gateways": {
"get": {
"description": "This endpoint allows you to pay for an order using Braintree and a users credit card.",
"summary": "Get a list of gateways",
"tags": [
"Gateways"
],
"operationId": "V2GatewaysGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/gateways",
"headers": {
"Accept": "application/json",
"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 gateways",
"x-testDescription": "This endpoint allows you to pay for an order using Braintree and a users credit card."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations/{variationID}/options/{optionID}/modifiers/{modifierID}": {
"put": {
"description": "",
"summary": "Update Product Modifier",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsModifiersModifierIDByVariationIDAndOptionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductModifierrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "optionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "modifierID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete Product Modifier",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsModifiersModifierIDByVariationIDAndOptionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "optionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "modifierID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/{categoryID}/relationships/categories": {
"delete": {
"description": "",
"summary": "Delete Category-Category Relationships",
"tags": [
"Categories"
],
"operationId": "CategoriesRelationshipsCategoriesByCategoryIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Delete categoryCategory relationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations/{variationID}/options/{optionID}/modifiers": {
"post": {
"description": "",
"summary": "Create Product Modifier",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsModifiersByVariationIDAndOptionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateProductModifierrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "optionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/attributes": {
"get": {
"description": "",
"summary": "Get Brand Attributes",
"tags": [
"Brands"
],
"operationId": "V2BrandsAttributesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/brands/attributes",
"headers": {
"Accept": "application/json",
"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 Brand Attributes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/gateways/stripe": {
"get": {
"description": "This endpoint allows you to pay for an order using Braintree and a users credit card.",
"summary": "Get a gateway (stripe)",
"tags": [
"Gateways"
],
"operationId": "V2GatewaysStripeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/gateways/stripe",
"headers": {
"Accept": "application/json",
"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 gateway (stripe)",
"x-testDescription": "This endpoint allows you to pay for an order using Braintree and a users credit card."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/collections/{collectionID}/relationships/children": {
"put": {
"summary": "Update Child Collection Relationship",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsChildrenByCollectionIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateChildCollectionRelationshiprequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"summary": "Create Child Collection Relationships",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsChildrenByCollectionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateChildCollectionRelationshipsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"summary": "Delete Child Collection Relationship",
"tags": [
"Collections"
],
"operationId": "V2CollectionsRelationshipsChildrenByCollectionIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "collectionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/{categoryID}/relationships/categories": {
"post": {
"description": "Using this endpoint you can create a relationship between a category and a parent category. When returning the category tree, you will see this relationship in place.",
"summary": "Create Parent Category Relationship",
"tags": [
"Categories"
],
"operationId": "V2CategoriesRelationshipsCategoriesByCategoryIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateParentCategoryRelationshiprequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/carts/123456/items/{cartItemID}": {
"delete": {
"description": "Delete an item from a cart. The remaining cart contents are returned on a successful delete.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart rather than the product_id",
"summary": "Delete an item from a cart",
"tags": [
"Carts"
],
"operationId": "V2Carts123456ItemsByCartItemIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cartItemID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders/{orderID}/items": {
"get": {
"description": "",
"summary": "Get Order Items",
"tags": [
"Orders"
],
"operationId": "OrdersItemsByOrderIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "orderID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/inventories/{productID}": {
"get": {
"description": "",
"summary": "Get stock for a product",
"tags": [
"Inventory"
],
"operationId": "V2InventoriesByProductIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/{integrationID}/jobs": {
"get": {
"description": "",
"summary": "Get all Jobs for an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsJobsByIntegrationIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/{integrationID}/jobs/{integrationJobID}/logs": {
"get": {
"description": "",
"summary": "Get Logs for a Job",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsJobsLogsByIntegrationIDAndIntegrationJobIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "integrationJobID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations": {
"get": {
"summary": "Get Integrations list",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/integrations",
"headers": {
"Accept": "application/json",
"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 Integrations list"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create an Integration",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAnIntegrationrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/integrations",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"integration\",\"integration_type\":\"email\",\"enabled\":false,\"name\":\"Emailer\",\"description\":\"email when these things happen\",\"observes\":[\"product.updated\",\"product.created\"],\"configuration\":{\"url\":\"https://demond.com\",\"secret_key\":\"SOME_KEY\"}}}"
},
"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 an Integration",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/orders/{orderID}/transactions/{TransactionID}/capture": {
"post": {
"summary": "Capture an authorize",
"tags": [
"Payments"
],
"operationId": "V2OrdersTransactionsCaptureByOrderIDAndTransactionIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "orderID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "TransactionID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/{productID}/build ": {
"post": {
"description": "",
"summary": "Build Child Products",
"tags": [
"Product Variations"
],
"operationId": "V2ProductsBuildByProductIDPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/BuildChildProductsrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "productID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/attributes": {
"get": {
"description": "",
"summary": "Get Category Attributes",
"tags": [
"Categories"
],
"operationId": "CategoriesAttributesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/categories/attributes",
"headers": {
"Accept": "application/json",
"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 Category Attributes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products/attributes": {
"get": {
"description": "",
"summary": "Get Product Attributes",
"tags": [
"Products"
],
"operationId": "V2ProductsAttributesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/products/attributes",
"headers": {
"Accept": "application/json",
"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 Product Attributes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/orders/{ORDER_ID}/transactions/{TRANSACTION_ID}/capture": {
"put": {
"description": "This endpoint allows you to pay for an order using Braintree and a users credit card.",
"summary": "Stripe - Card Update",
"tags": [
"Gateways"
],
"operationId": "V2OrdersTransactionsCaptureByORDERIDAndTRANSACTIONIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Stripe card updaterequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "ORDER_ID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "TRANSACTION_ID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/{categoryID}/relationships/parent": {
"delete": {
"description": "",
"summary": "Delete Parent Category Parent",
"tags": [
"Categories"
],
"operationId": "V2CategoriesRelationshipsParentByCategoryIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "categoryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/files": {
"get": {
"description": "",
"summary": "Get all files",
"tags": [
"Files"
],
"operationId": "V2FilesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "page[limit]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "sort",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "filter",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/files?page[offset]=0&page[limit]=10&sort={{sort}}&filter={{filter}}",
"headers": {
"Accept": "application/json",
"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 files",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a file",
"tags": [
"Files"
],
"operationId": "V2FilesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/files",
"headers": {
"Accept": "application/json",
"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": "Create a file",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories": {
"get": {
"description": "",
"summary": "Get Categories List",
"tags": [
"Categories"
],
"operationId": "V2CategoriesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/categories",
"headers": {
"Accept": "application/json",
"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 Categories List",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a Category",
"tags": [
"Categories"
],
"operationId": "V2CategoriesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateACategoryrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/categories",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"category\",\"name\":\"Clothing\",\"slug\":\"clothing\",\"description\":\"Browse our clothing line\",\"status\":\"live\"}}"
},
"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 Category",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/categories/tree": {
"get": {
"description": "",
"summary": "Category Tree",
"tags": [
"Categories"
],
"operationId": "V2CategoriesCategoriesTreeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/categories/categories/tree",
"headers": {
"Accept": "application/json",
"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": "Category Tree",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/carts/{cartRef}": {
"delete": {
"description": "Removes all items in a cart.",
"summary": "Delete a Cart",
"tags": [
"Carts"
],
"operationId": "CartsByCartRefDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cartRef",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/integrations/logs": {
"get": {
"description": "",
"summary": "Get all Logs",
"tags": [
"Integrations"
],
"operationId": "V2IntegrationsLogsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/integrations/logs",
"headers": {
"Accept": "application/json",
"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 Logs",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands": {
"get": {
"description": "",
"summary": "Get a list of Brands",
"tags": [
"Brands"
],
"operationId": "V2BrandsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/brands",
"headers": {
"Accept": "application/json",
"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 Brands",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a Brand",
"tags": [
"Brands"
],
"operationId": "V2BrandsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateABrandrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/brands",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"brand\",\"name\":\"Cool Clothing\",\"slug\":\"cool-clothing\",\"description\":\"Cool clothing make cool clothes!\",\"status\":\"live\"}}"
},
"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 Brand",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/promotions": {
"get": {
"description": "",
"summary": "Get a list of promotions",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/promotions",
"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 promotions",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a promotion",
"tags": [
"Promotions"
],
"operationId": "V2PromotionsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAPromotionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/promotions",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"data\":{\"type\":\"promotion\",\"name\":\"Promo #1\",\"description\":\"Initial Promotion\",\"enabled\":true,\"promotion_type\":\"fixed_discount\",\"schema\":{\"currencies\":[{\"currency\":\"USD\",\"amount\":900},{\"currency\":\"GBP\",\"amount\":1100}]},\"start\":\"2017-01-13\",\"end\":\"2018-01-13\"}}"
},
"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 promotion",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/customers/tokens ": {
"post": {
"description": "",
"summary": "Generate a customer token",
"tags": [
"Customers"
],
"operationId": "V2CustomersTokensPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/GenerateACustomerTokenrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/customers/tokens ",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"token\",\"email\":\"ron@swanson.com\",\"password\":\"mysecretpassword\"}}"
},
"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": "Generate a customer token",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/brands/{brandID}/relationships/brands": {
"post": {
"description": "",
"summary": "Create Brand Relationships",
"tags": [
"Brand Relationship"
],
"operationId": "V2BrandsRelationshipsBrandsByBrandIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateBrandRelationshipsrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "brandID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/products": {
"get": {
"description": "",
"summary": "Get Products List",
"tags": [
"Products"
],
"operationId": "V2ProductsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "page[limit]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "sort",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "filter",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "include",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/products?page[offset]=0&page[limit]=10&sort={{sort}}&filter={{filter}}&include={{include}}",
"headers": {
"Accept": "application/json",
"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 Products List",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new Product",
"tags": [
"Products"
],
"operationId": "V2ProductsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/v2/products",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{\"data\":{\"type\":\"product\",\"name\":\"Some Product\",\"slug\":\"some-product-3\",\"sku\":\"SP01-{COLOUR}-3\",\"manage_stock\":false,\"description\":\"Some description\",\"status\":\"draft\",\"commodity_type\":\"physical\",\"price\":[{\"amount\":5999,\"currency\":\"GBP\",\"includes_tax\":true},{\"amount\":5499,\"currency\":\"USD\",\"includes_tax\":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 new Product",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/flows/{flowSlug}/entries/{entryID}/relationships/{fieldSlug}": {
"post": {
"summary": "Create Entry Relationship(s)",
"tags": [
"Flows"
],
"operationId": "V2FlowsEntriesRelationshipsFieldSlugByFlowSlugAndEntryIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateEntryRelationship(s)request"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "flowSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "entryID",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fieldSlug",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/categories/tree": {
"get": {
"description": "",
"summary": "Get Categories Tree",
"tags": [
"Categories"
],
"operationId": "V2CategoriesTreeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/categories/tree",
"headers": {
"Accept": "application/json",
"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 Categories Tree",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/variations/{variationID}/options": {
"post": {
"summary": "Create a Product Variation Option",
"tags": [
"Product Variations"
],
"operationId": "V2VariationsOptionsByVariationIDPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAProductVariationOptionrequest"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "variationID",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/v2/orders": {
"get": {
"description": "",
"summary": "Get all orders",
"tags": [
"Orders"
],
"operationId": "V2OrdersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/v2/orders",
"headers": {
"Accept": "application/json",
"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",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"CreatePromotionCodesrequest": {
"title": "Create promotion codesRequest",
"example": {
"data": {
"type": "promotion_codes",
"codes": [
{
"code": "ZXY_CBA"
},
{
"code": "ABC_XYZ"
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data"
}
},
"required": [
"data"
]
},
"Data": {
"title": "Data",
"example": {
"type": "promotion_codes",
"codes": [
{
"code": "ZXY_CBA"
},
{
"code": "ABC_XYZ"
}
]
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "promotion_codes",
"type": "string"
},
"codes": {
"description": "",
"example": [
{
"code": "ZXY_CBA"
},
{
"code": "ABC_XYZ"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Code"
}
}
},
"required": [
"type",
"codes"
]
},
"Code": {
"title": "Code",
"example": {
"code": "ZXY_CBA"
},
"type": "object",
"properties": {
"code": {
"description": "",
"example": "ZXY_CBA",
"type": "string"
}
},
"required": [
"code"
]
},
"UpdateAnIntegrationrequest": {
"title": "Update an IntegrationRequest",
"example": {
"data": {
"type": "integration",
"id": "{{integrationID}}",
"integration_type": "email",
"enabled": false,
"name": "Emailer",
"description": "email when these things happen",
"observes": [
"integration.deleted",
"product.updated",
"product.created",
"file.created"
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data4"
}
},
"required": [
"data"
]
},
"Data4": {
"title": "Data4",
"example": {
"type": "integration",
"id": "{{integrationID}}",
"integration_type": "email",
"enabled": false,
"name": "Emailer",
"description": "email when these things happen",
"observes": [
"integration.deleted",
"product.updated",
"product.created",
"file.created"
]
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "integration",
"type": "string"
},
"id": {
"description": "",
"example": "{{integrationID}}",
"type": "string"
},
"integration_type": {
"description": "",
"example": "email",
"type": "string"
},
"enabled": {
"description": "",
"example": false,
"type": "boolean"
},
"name": {
"description": "",
"example": "Emailer",
"type": "string"
},
"description": {
"description": "",
"example": "email when these things happen",
"type": "string"
},
"observes": {
"description": "",
"example": [
"integration.deleted",
"product.updated",
"product.created",
"file.created"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"id",
"integration_type",
"enabled",
"name",
"description",
"observes"
]
},
"UpdateACustomerrequest": {
"title": "Update a CustomerRequest",
"example": {
"data": {
"type": "customer",
"email": "ron@swanson.com"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data6"
}
},
"required": [
"data"
]
},
"Data6": {
"title": "Data6",
"example": {
"type": "customer",
"email": "ron@swanson.com"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "customer",
"type": "string"
},
"email": {
"description": "",
"example": "ron@swanson.com",
"type": "string"
}
},
"required": [
"type",
"email"
]
},
"UpdateParentBrandRelationshiprequest": {
"title": "Update Parent Brand RelationshipRequest",
"example": {
"data": {
"type": "brand",
"id": "c902aea9-ec90-4fdd-8084-3c2d879a2c52"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"Data8": {
"title": "Data8",
"example": {
"type": "brand",
"id": "c902aea9-ec90-4fdd-8084-3c2d879a2c52"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "brand",
"type": "string"
},
"id": {
"description": "",
"example": "c902aea9-ec90-4fdd-8084-3c2d879a2c52",
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"UpdatePromotionrequest": {
"title": "Update promotionRequest",
"example": {
"data": {
"type": "promotion",
"id": "{{promotionID}}",
"name": "Promo #1",
"description": "Initial Promotion",
"enabled": true,
"promotion_type": "fixed_discount",
"schema": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"start": "2017-11-13",
"end": "2019-11-13"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data10"
}
},
"required": [
"data"
]
},
"Data10": {
"title": "Data10",
"example": {
"type": "promotion",
"id": "{{promotionID}}",
"name": "Promo #1",
"description": "Initial Promotion",
"enabled": true,
"promotion_type": "fixed_discount",
"schema": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"start": "2017-11-13",
"end": "2019-11-13"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "promotion",
"type": "string"
},
"id": {
"description": "",
"example": "{{promotionID}}",
"type": "string"
},
"name": {
"description": "",
"example": "Promo #1",
"type": "string"
},
"description": {
"description": "",
"example": "Initial Promotion",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"promotion_type": {
"description": "",
"example": "fixed_discount",
"type": "string"
},
"schema": {
"$ref": "#/definitions/Schema"
},
"start": {
"description": "",
"example": "2017-11-13",
"type": "string"
},
"end": {
"description": "",
"example": "2019-11-13",
"type": "string"
}
},
"required": [
"type",
"id",
"name",
"description",
"enabled",
"promotion_type",
"schema",
"start",
"end"
]
},
"Schema": {
"title": "Schema",
"example": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"type": "object",
"properties": {
"currencies": {
"description": "",
"example": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Currency"
}
}
},
"required": [
"currencies"
]
},
"Currency": {
"title": "Currency",
"example": {
"currency": "USD",
"amount": 900
},
"type": "object",
"properties": {
"currency": {
"description": "",
"example": "USD",
"type": "string"
},
"amount": {
"description": "",
"example": 900,
"type": "integer",
"format": "int32"
}
},
"required": [
"currency",
"amount"
]
},
"AddAnItemToACartrequest": {
"title": "Add an item to a cartRequest",
"example": {
"data": {
"type": "cart_item",
"id": "{{productID}}",
"quantity": 2
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data14"
}
},
"required": [
"data"
]
},
"Data14": {
"title": "Data14",
"example": {
"type": "cart_item",
"id": "{{productID}}",
"quantity": 2
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "cart_item",
"type": "string"
},
"id": {
"description": "",
"example": "{{productID}}",
"type": "string"
},
"quantity": {
"description": "",
"example": 2,
"type": "integer",
"format": "int32"
}
},
"required": [
"type",
"id",
"quantity"
]
},
"CreateProducts<=>FilesRelationshipsrequest": {
"title": "Create Products <=> Files RelationshipsRequest",
"example": {
"data": [
{
"type": "file",
"id": "{{fileID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "file",
"id": "{{fileID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"Braintree updaterequest": {
"title": "Braintree - UpdateRequest",
"example": {
"data": {
"enabled": true,
"environment": "production",
"merchant_id": "xxx",
"private_key": "xxx",
"public_key": "xxx"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data18"
}
},
"required": [
"data"
]
},
"Data18": {
"title": "Data18",
"example": {
"enabled": true,
"environment": "production",
"merchant_id": "xxx",
"private_key": "xxx",
"public_key": "xxx"
},
"type": "object",
"properties": {
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"environment": {
"description": "",
"example": "production",
"type": "string"
},
"merchant_id": {
"description": "",
"example": "xxx",
"type": "string"
},
"private_key": {
"description": "",
"example": "xxx",
"type": "string"
},
"public_key": {
"description": "",
"example": "xxx",
"type": "string"
}
},
"required": [
"enabled",
"environment",
"merchant_id",
"private_key",
"public_key"
]
},
"CreateCollectionRelationshipsrequest": {
"title": "Create Collection RelationshipsRequest",
"example": {
"data": {
"parent": {
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
"children": [
{
"type": "collection",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data20"
}
},
"required": [
"data"
]
},
"Data20": {
"title": "Data20",
"example": {
"parent": {
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
"children": [
{
"type": "collection",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
]
},
"type": "object",
"properties": {
"parent": {
"$ref": "#/definitions/Parent"
},
"children": {
"description": "",
"example": [
{
"type": "collection",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Child"
}
}
},
"required": [
"parent",
"children"
]
},
"Parent": {
"title": "Parent",
"example": {
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "collection",
"type": "string"
},
"id": {
"description": "",
"example": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c",
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"Child": {
"title": "Child",
"example": {
"type": "collection",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "collection",
"type": "string"
},
"id": {
"description": "",
"example": "1334e667-7b2b-4159-9e36-8a3b404901c8",
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"DeleteProducts<=>FilesRelationshiprequest": {
"title": "Delete Products <=> Files RelationshipRequest",
"example": {
"data": [
{
"type": "file",
"id": "{{fileID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "file",
"id": "{{fileID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"DeleteChildCategoryRelationshipsrequest": {
"title": "Delete Child Category RelationshipsRequest",
"example": {
"data": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateACollectionrequest": {
"title": "Create a CollectionRequest",
"example": {
"data": {
"type": "collection",
"name": "Winter Season",
"slug": "winter-season",
"description": "Our Winter Season is now live!",
"status": "live"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data28"
}
},
"required": [
"data"
]
},
"Data28": {
"title": "Data28",
"example": {
"type": "collection",
"name": "Winter Season",
"slug": "winter-season",
"description": "Our Winter Season is now live!",
"status": "live"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "collection",
"type": "string"
},
"name": {
"description": "",
"example": "Winter Season",
"type": "string"
},
"slug": {
"description": "",
"example": "winter-season",
"type": "string"
},
"description": {
"description": "",
"example": "Our Winter Season is now live!",
"type": "string"
},
"status": {
"description": "",
"example": "live",
"type": "string"
}
},
"required": [
"type",
"name",
"slug",
"description",
"status"
]
},
"CreateChildCategoryRelationshipsrequest": {
"title": "Create Child Category RelationshipsRequest",
"example": {
"data": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateABrandrequest": {
"title": "Update a BrandRequest",
"example": {
"data": {
"type": "brand",
"id": "{{brandID}}",
"name": "Brand #1 Update",
"slug": "brand-1-update",
"status": "draft",
"description": "first brand updated"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data32"
}
},
"required": [
"data"
]
},
"Data32": {
"title": "Data32",
"example": {
"type": "brand",
"id": "{{brandID}}",
"name": "Brand #1 Update",
"slug": "brand-1-update",
"status": "draft",
"description": "first brand updated"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "brand",
"type": "string"
},
"id": {
"description": "",
"example": "{{brandID}}",
"type": "string"
},
"name": {
"description": "",
"example": "Brand #1 Update",
"type": "string"
},
"slug": {
"description": "",
"example": "brand-1-update",
"type": "string"
},
"status": {
"description": "",
"example": "draft",
"type": "string"
},
"description": {
"description": "",
"example": "first brand updated",
"type": "string"
}
},
"required": [
"type",
"id",
"name",
"slug",
"status",
"description"
]
},
"UpdateAnEntryrequest": {
"title": "Update an entryRequest",
"example": {
"data": {
"type": "entry",
"id": "{{entryID}}",
"field_one": "eiusmod Ut amet in",
"field_two": -41701689
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data34"
}
},
"required": [
"data"
]
},
"Data34": {
"title": "Data34",
"example": {
"type": "entry",
"id": "{{entryID}}",
"field_one": "eiusmod Ut amet in",
"field_two": -41701689
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "entry",
"type": "string"
},
"id": {
"description": "",
"example": "{{entryID}}",
"type": "string"
},
"field_one": {
"description": "",
"example": "eiusmod Ut amet in",
"type": "string"
},
"field_two": {
"description": "",
"example": -41701689,
"type": "integer",
"format": "int32"
}
},
"required": [
"type",
"id",
"field_one",
"field_two"
]
},
"CreateAnAddressrequest": {
"title": "Create an AddressRequest",
"example": {
"data": {
"type": "address",
"first_name": "Ron",
"last_name": "Swanson",
"name": "Home",
"phone_number": "(555) 555-1234",
"instructions": "Leave behind the bins",
"company_name": "Ron Swanson Enterprises",
"line_1": "1 Sunny Street",
"line_2": "",
"city": "Sunny Town",
"county": "Sunnyville",
"postcode": "SU33 1YY",
"country": "GB"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data36"
}
},
"required": [
"data"
]
},
"Data36": {
"title": "Data36",
"example": {
"type": "address",
"first_name": "Ron",
"last_name": "Swanson",
"name": "Home",
"phone_number": "(555) 555-1234",
"instructions": "Leave behind the bins",
"company_name": "Ron Swanson Enterprises",
"line_1": "1 Sunny Street",
"line_2": "",
"city": "Sunny Town",
"county": "Sunnyville",
"postcode": "SU33 1YY",
"country": "GB"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "address",
"type": "string"
},
"first_name": {
"description": "",
"example": "Ron",
"type": "string"
},
"last_name": {
"description": "",
"example": "Swanson",
"type": "string"
},
"name": {
"description": "",
"example": "Home",
"type": "string"
},
"phone_number": {
"description": "",
"example": "(555) 555-1234",
"type": "string"
},
"instructions": {
"description": "",
"example": "Leave behind the bins",
"type": "string"
},
"company_name": {
"description": "",
"example": "Ron Swanson Enterprises",
"type": "string"
},
"line_1": {
"description": "",
"example": "1 Sunny Street",
"type": "string"
},
"line_2": {
"description": "",
"type": "string"
},
"city": {
"description": "",
"example": "Sunny Town",
"type": "string"
},
"county": {
"description": "",
"example": "Sunnyville",
"type": "string"
},
"postcode": {
"description": "",
"example": "SU33 1YY",
"type": "string"
},
"country": {
"description": "",
"example": "GB",
"type": "string"
}
},
"required": [
"type",
"first_name",
"last_name",
"name",
"phone_number",
"instructions",
"company_name",
"line_1",
"line_2",
"city",
"county",
"postcode",
"country"
]
},
"Adyen card updaterequest": {
"title": "Adyen - Card UpdateRequest",
"example": {
"data": {
"enabled": true,
"merchant_account": "xxx",
"password": "xxx",
"test": false,
"username": "xxx"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data38"
}
},
"required": [
"data"
]
},
"Data38": {
"title": "Data38",
"example": {
"enabled": true,
"merchant_account": "xxx",
"password": "xxx",
"test": false,
"username": "xxx"
},
"type": "object",
"properties": {
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"merchant_account": {
"description": "",
"example": "xxx",
"type": "string"
},
"password": {
"description": "",
"example": "xxx",
"type": "string"
},
"test": {
"description": "",
"example": false,
"type": "boolean"
},
"username": {
"description": "",
"example": "xxx",
"type": "string"
}
},
"required": [
"enabled",
"merchant_account",
"password",
"test",
"username"
]
},
"CreateParentBrandRelationshiprequest": {
"title": "Create Parent Brand RelationshipRequest",
"example": {
"data": {
"type": "brand",
"id": "{{brandID}}"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"UpdateAnItemInACartrequest": {
"title": "Update an item in a cartRequest",
"example": {
"data": {
"type": "cart_item",
"id": "76746981-f63a-45f4-ba9e-59773d89dc2e",
"quantity": 2
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data14"
}
},
"required": [
"data"
]
},
"UpdateEntryRelationship(s)request": {
"title": "Update Entry Relationship(s)Request",
"example": {
"data": [
{
"type": "{{RESOURCE_TYPE}}",
"id": "{{RESOURCE_ID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "{{RESOURCE_TYPE}}",
"id": "{{RESOURCE_ID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateAStockTransactionForAProductrequest": {
"title": "Create a stock transaction for a productRequest",
"example": {
"data": {
"type": "stock-transaction",
"action": "increment",
"quantity": 3
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data46"
}
},
"required": [
"data"
]
},
"Data46": {
"title": "Data46",
"example": {
"type": "stock-transaction",
"action": "increment",
"quantity": 3
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "stock-transaction",
"type": "string"
},
"action": {
"description": "",
"example": "increment",
"type": "string"
},
"quantity": {
"description": "",
"example": 3,
"type": "integer",
"format": "int32"
}
},
"required": [
"type",
"action",
"quantity"
]
},
"Create categoryCategory relationshipsrequest": {
"title": "Create Category-Category RelationshipsRequest",
"example": {
"data": {
"parent": {
"type": "category",
"id": "PARENT_CATEGORY_UUID"
},
"children": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data20"
}
},
"required": [
"data"
]
},
"CreateProduct<=>BrandsRelationshipsrequest": {
"title": "Create Product <=> Brands RelationshipsRequest",
"example": {
"data": [
{
"type": "brand",
"id": "{{brandID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "{{brandID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateChildBrandRelationshiprequest": {
"title": "Update Child Brand RelationshipRequest",
"example": {
"data": [
{
"type": "brand",
"id": "c902aea9-ec90-4fdd-8084-3c2d879a2c52"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "c902aea9-ec90-4fdd-8084-3c2d879a2c52"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateAProductVariationrequest": {
"title": "Update a Product VariationRequest",
"example": {
"data": {
"type": "product-variation",
"id": "{{variationID}}",
"name": "Colour"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data56"
}
},
"required": [
"data"
]
},
"Data56": {
"title": "Data56",
"example": {
"type": "product-variation",
"id": "{{variationID}}",
"name": "Colour"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "product-variation",
"type": "string"
},
"id": {
"description": "",
"example": "{{variationID}}",
"type": "string"
},
"name": {
"description": "",
"example": "Colour",
"type": "string"
}
},
"required": [
"type",
"id",
"name"
]
},
"CreateACustomerrequest": {
"title": "Create a CustomerRequest",
"example": {
"data": {
"type": "customer",
"name": "Ron Swanson+5",
"email": "ron+5@swanson.com",
"password": "mysecretpassword"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data58"
}
},
"required": [
"data"
]
},
"Data58": {
"title": "Data58",
"example": {
"type": "customer",
"name": "Ron Swanson+5",
"email": "ron+5@swanson.com",
"password": "mysecretpassword"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "customer",
"type": "string"
},
"name": {
"description": "",
"example": "Ron Swanson+5",
"type": "string"
},
"email": {
"description": "",
"example": "ron+5@swanson.com",
"type": "string"
},
"password": {
"description": "",
"example": "mysecretpassword",
"type": "string"
}
},
"required": [
"type",
"name",
"email",
"password"
]
},
"UpdateSettingsrequest": {
"title": "Update SettingsRequest",
"example": {
"data": {
"type": "settings",
"page_length": 70,
"list_child_products": false,
"additional_languages": [
"es",
"fr",
"de"
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data60"
}
},
"required": [
"data"
]
},
"Data60": {
"title": "Data60",
"example": {
"type": "settings",
"page_length": 70,
"list_child_products": false,
"additional_languages": [
"es",
"fr",
"de"
]
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "settings",
"type": "string"
},
"page_length": {
"description": "",
"example": 70,
"type": "integer",
"format": "int32"
},
"list_child_products": {
"description": "",
"example": false,
"type": "boolean"
},
"additional_languages": {
"description": "",
"example": [
"es",
"fr",
"de"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"page_length",
"list_child_products",
"additional_languages"
]
},
"CreateProducts<=>MainImageRelationshipsrequest": {
"title": "Create Products <=> Main Image RelationshipsRequest",
"example": {
"data": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
{
"type": "brand",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
{
"type": "brand",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateAnEntryrequest": {
"title": "Create an entryRequest",
"example": {
"data": {
"type": "entry",
"{FIELD_SLUG}": "a value"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data64"
}
},
"required": [
"data"
]
},
"Data64": {
"title": "Data64",
"example": {
"type": "entry",
"{FIELD_SLUG}": "a value"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "entry",
"type": "string"
},
"{FIELD_SLUG}": {
"description": "",
"example": "a value",
"type": "string"
}
},
"required": [
"type",
"{FIELD_SLUG}"
]
},
"CheckoutUsingCustomerObjectrequest": {
"title": "Checkout using customer objectRequest",
"example": {
"data": {
"customer": {
"email": "john@moltin.com",
"name": "John Doe"
},
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK"
},
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"phone_number": "(555) 555-1234",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK",
"instructions": "Leave in porch"
}
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data66"
}
},
"required": [
"data"
]
},
"Data66": {
"title": "Data66",
"example": {
"customer": {
"email": "john@moltin.com",
"name": "John Doe"
},
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK"
},
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"phone_number": "(555) 555-1234",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK",
"instructions": "Leave in porch"
}
},
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
},
"billing_address": {
"$ref": "#/definitions/BillingAddress"
},
"shipping_address": {
"$ref": "#/definitions/ShippingAddress"
}
},
"required": [
"customer",
"billing_address",
"shipping_address"
]
},
"Customer": {
"title": "Customer",
"example": {
"email": "john@moltin.com",
"name": "John Doe"
},
"type": "object",
"properties": {
"email": {
"description": "",
"example": "john@moltin.com",
"type": "string"
},
"name": {
"description": "",
"example": "John Doe",
"type": "string"
}
},
"required": [
"email",
"name"
]
},
"BillingAddress": {
"title": "BillingAddress",
"example": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK"
},
"type": "object",
"properties": {
"first_name": {
"description": "",
"example": "John",
"type": "string"
},
"last_name": {
"description": "",
"example": "Doe",
"type": "string"
},
"company_name": {
"description": "",
"example": "Moltin",
"type": "string"
},
"line_1": {
"description": "",
"example": "2nd Floor British India House",
"type": "string"
},
"line_2": {
"description": "",
"example": "15 Carliol Square",
"type": "string"
},
"city": {
"description": "",
"example": "Newcastle upon Tyne",
"type": "string"
},
"postcode": {
"description": "",
"example": "NE1 6UF",
"type": "string"
},
"county": {
"description": "",
"example": "Tyne & Wear",
"type": "string"
},
"country": {
"description": "",
"example": "UK",
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"company_name",
"line_1",
"line_2",
"city",
"postcode",
"county",
"country"
]
},
"ShippingAddress": {
"title": "ShippingAddress",
"example": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"phone_number": "(555) 555-1234",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK",
"instructions": "Leave in porch"
},
"type": "object",
"properties": {
"first_name": {
"description": "",
"example": "John",
"type": "string"
},
"last_name": {
"description": "",
"example": "Doe",
"type": "string"
},
"company_name": {
"description": "",
"example": "Moltin",
"type": "string"
},
"phone_number": {
"description": "",
"example": "(555) 555-1234",
"type": "string"
},
"line_1": {
"description": "",
"example": "2nd Floor British India House",
"type": "string"
},
"line_2": {
"description": "",
"example": "15 Carliol Square",
"type": "string"
},
"city": {
"description": "",
"example": "Newcastle upon Tyne",
"type": "string"
},
"postcode": {
"description": "",
"example": "NE1 6UF",
"type": "string"
},
"county": {
"description": "",
"example": "Tyne & Wear",
"type": "string"
},
"country": {
"description": "",
"example": "UK",
"type": "string"
},
"instructions": {
"description": "",
"example": "Leave in porch",
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"company_name",
"phone_number",
"line_1",
"line_2",
"city",
"postcode",
"county",
"country",
"instructions"
]
},
"DeleteProduct<=>CategoriesRelationshipsrequest": {
"title": "Delete Product <=> Categories RelationshipsRequest",
"example": {
"data": [
{
"type": "category",
"id": "{{categoryID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "category",
"id": "{{categoryID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateParentCollectionRelationshiprequest": {
"title": "Update Parent Collection RelationshipRequest",
"example": {
"data": {
"type": "collection",
"id": "85f4f643-e66b-4deb-b9da-dd14c5cbc013"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"UpdateACategoryrequest": {
"title": "Update a CategoryRequest",
"example": {
"data": {
"type": "category",
"id": "{{categoryID}}",
"name": "Category #1 Updated",
"slug": "category-1-update",
"status": "draft",
"description": "first category updated"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data32"
}
},
"required": [
"data"
]
},
"CreateACurrencyrequest": {
"title": "Create a CurrencyRequest",
"example": {
"data": {
"type": "currency",
"code": "GBP",
"exchange_rate": 1,
"format": "£{price}",
"decimal_point": ".",
"thousand_separator": ",",
"decimal_places": 2,
"default": false,
"enabled": true
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data77"
}
},
"required": [
"data"
]
},
"Data77": {
"title": "Data77",
"example": {
"type": "currency",
"code": "GBP",
"exchange_rate": 1,
"format": "£{price}",
"decimal_point": ".",
"thousand_separator": ",",
"decimal_places": 2,
"default": false,
"enabled": true
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "currency",
"type": "string"
},
"code": {
"description": "",
"example": "GBP",
"type": "string"
},
"exchange_rate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"format": {
"description": "",
"example": "£{price}",
"type": "string"
},
"decimal_point": {
"description": "",
"example": ".",
"type": "string"
},
"thousand_separator": {
"description": "",
"example": ",",
"type": "string"
},
"decimal_places": {
"description": "",
"example": 2,
"type": "integer",
"format": "int32"
},
"default": {
"description": "",
"example": false,
"type": "boolean"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"type",
"code",
"exchange_rate",
"format",
"decimal_point",
"thousand_separator",
"decimal_places",
"default",
"enabled"
]
},
"DeleteProducts<=>CollectionsRelationshipsrequest": {
"title": "Delete Products <=> Collections RelationshipsRequest",
"example": {
"data": [
{
"type": "collection",
"id": "{{collectionID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "collection",
"id": "{{collectionID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateACurrencyrequest": {
"title": "Update a CurrencyRequest",
"example": {
"data": {
"enabled": true
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data81"
}
},
"required": [
"data"
]
},
"Data81": {
"title": "Data81",
"example": {
"enabled": true
},
"type": "object",
"properties": {
"enabled": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"UpdateAProductVariationOptionrequest": {
"title": "Update a Product Variation OptionRequest",
"example": {
"data": {
"type": "product-variation-option",
"id": "{{optionID}}",
"name": "RED",
"description": "Reddish"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data83"
}
},
"required": [
"data"
]
},
"Data83": {
"title": "Data83",
"example": {
"type": "product-variation-option",
"id": "{{optionID}}",
"name": "RED",
"description": "Reddish"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "product-variation-option",
"type": "string"
},
"id": {
"description": "",
"example": "{{optionID}}",
"type": "string"
},
"name": {
"description": "",
"example": "RED",
"type": "string"
},
"description": {
"description": "",
"example": "Reddish",
"type": "string"
}
},
"required": [
"type",
"id",
"name",
"description"
]
},
"CreateProduct<=>CategoriesRelationshipsrequest": {
"title": "Create Product <=> Categories RelationshipsRequest",
"example": {
"data": [
{
"type": "category",
"id": "{{categoryID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "category",
"id": "{{categoryID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateChildCategoryRelationshipsrequest": {
"title": "Update Child Category RelationshipsRequest",
"example": {
"data": [
{
"type": "category",
"id": "NEW_CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "NEW_CHILD_CATEGORY2_UUID"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "category",
"id": "NEW_CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "NEW_CHILD_CATEGORY2_UUID"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateParentCategoryParentrequest": {
"title": "Update Parent Category ParentRequest",
"example": {
"data": {
"type": "category",
"id": "NEW_PARENT_UUID"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"UpdateProductModifierrequest": {
"title": "Update Product ModifierRequest",
"example": {
"data": {
"type": "modifier",
"id": "{{modifierID}}",
"modifer_type": "name_equals",
"value": "Updated product name"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data91"
}
},
"required": [
"data"
]
},
"Data91": {
"title": "Data91",
"example": {
"type": "modifier",
"id": "{{modifierID}}",
"modifer_type": "name_equals",
"value": "Updated product name"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "modifier",
"type": "string"
},
"id": {
"description": "",
"example": "{{modifierID}}",
"type": "string"
},
"modifer_type": {
"description": "",
"example": "name_equals",
"type": "string"
},
"value": {
"description": "",
"example": "Updated product name",
"type": "string"
}
},
"required": [
"type",
"id",
"modifer_type",
"value"
]
},
"Delete categoryCategory relationshipsrequest": {
"title": "Delete Category-Category RelationshipsRequest",
"example": {
"data": {
"parent": {
"type": "category",
"id": "PARENT_CATEGORY_UUID"
},
"children": [
{
"type": "category",
"id": "CHILD_CATEGORY1_UUID"
},
{
"type": "category",
"id": "CHILD_CATEGORY2_UUID"
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data20"
}
},
"required": [
"data"
]
},
"UpdateProducts<=>CollectionsRelationshipsrequest": {
"title": "Update Products <=> Collections RelationshipsRequest",
"example": {
"data": [
{
"type": "collection",
"id": "{{collectionID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "collection",
"id": "{{collectionID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateProducts<=>CollectionsRelationshipsrequest": {
"title": "Create Products <=> Collections RelationshipsRequest",
"example": {
"data": [
{
"type": "collection",
"id": "10229491-7dbb-424d-be08-80c5735795cc"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "collection",
"id": "10229491-7dbb-424d-be08-80c5735795cc"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CheckoutUsingCustomerIdrequest": {
"title": "Checkout using customer idRequest",
"example": {
"data": {
"customer": {
"id": "{{customerID}}"
},
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK"
},
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"phone_number": "(555) 555-1234",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK",
"instructions": "Leave in porch"
}
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data101"
}
},
"required": [
"data"
]
},
"Data101": {
"title": "Data101",
"example": {
"customer": {
"id": "{{customerID}}"
},
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK"
},
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"phone_number": "(555) 555-1234",
"company_name": "Moltin",
"line_1": "2nd Floor British India House",
"line_2": "15 Carliol Square",
"city": "Newcastle upon Tyne",
"postcode": "NE1 6UF",
"county": "Tyne & Wear",
"country": "UK",
"instructions": "Leave in porch"
}
},
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer102"
},
"billing_address": {
"$ref": "#/definitions/BillingAddress"
},
"shipping_address": {
"$ref": "#/definitions/ShippingAddress"
}
},
"required": [
"customer",
"billing_address",
"shipping_address"
]
},
"Customer102": {
"title": "Customer102",
"example": {
"id": "{{customerID}}"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": "{{customerID}}",
"type": "string"
}
},
"required": [
"id"
]
},
"CreateProductModifierrequest": {
"title": "Create Product ModifierRequest",
"example": {
"data": {
"type": "modifier",
"modifier_type": "name_equals",
"value": "Promotional product"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data106"
}
},
"required": [
"data"
]
},
"Data106": {
"title": "Data106",
"example": {
"type": "modifier",
"modifier_type": "name_equals",
"value": "Promotional product"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "modifier",
"type": "string"
},
"modifier_type": {
"description": "",
"example": "name_equals",
"type": "string"
},
"value": {
"description": "",
"example": "Promotional product",
"type": "string"
}
},
"required": [
"type",
"modifier_type",
"value"
]
},
"UpdateChildCollectionRelationshiprequest": {
"title": "Update Child Collection RelationshipRequest",
"example": {
"data": [
{
"type": "collection",
"id": "85f4f643-e66b-4deb-b9da-dd14c5cbc013"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "collection",
"id": "85f4f643-e66b-4deb-b9da-dd14c5cbc013"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateParentCategoryRelationshiprequest": {
"title": "Create Parent Category RelationshipRequest",
"example": {
"data": {
"type": "category",
"id": "{{parentCatID}}"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"CreateChildBrandRelationshiprequest": {
"title": "Create Child Brand RelationshipRequest",
"example": {
"data": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateAFlowrequest": {
"title": "Update a flowRequest",
"example": {
"data": {
"type": "flow",
"id": "{{flowID}}",
"name": "extraFieldRenamed",
"enabled": true
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data114"
}
},
"required": [
"data"
]
},
"Data114": {
"title": "Data114",
"example": {
"type": "flow",
"id": "{{flowID}}",
"name": "extraFieldRenamed",
"enabled": true
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "flow",
"type": "string"
},
"id": {
"description": "",
"example": "{{flowID}}",
"type": "string"
},
"name": {
"description": "",
"example": "extraFieldRenamed",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"type",
"id",
"name",
"enabled"
]
},
"CreateAFlowrequest": {
"title": "Create a flowRequest",
"example": {
"data": {
"type": "flow",
"name": "Products",
"slug": "products",
"description": "Extends the default product object",
"enabled": true
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data116"
}
},
"required": [
"data"
]
},
"Data116": {
"title": "Data116",
"example": {
"type": "flow",
"name": "Products",
"slug": "products",
"description": "Extends the default product object",
"enabled": true
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "flow",
"type": "string"
},
"name": {
"description": "",
"example": "Products",
"type": "string"
},
"slug": {
"description": "",
"example": "products",
"type": "string"
},
"description": {
"description": "",
"example": "Extends the default product object",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"type",
"name",
"slug",
"description",
"enabled"
]
},
"UpdateAFieldrequest": {
"title": "Update a fieldRequest",
"example": {
"data": {
"type": "field",
"id": "{{fieldID}}",
"field_type": "date",
"slug": "start-of-life",
"name": "start-of-life",
"description": "day the iphone will work",
"required": true,
"unique": false,
"default": "2018-01-01"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data118"
}
},
"required": [
"data"
]
},
"Data118": {
"title": "Data118",
"example": {
"type": "field",
"id": "{{fieldID}}",
"field_type": "date",
"slug": "start-of-life",
"name": "start-of-life",
"description": "day the iphone will work",
"required": true,
"unique": false,
"default": "2018-01-01"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "field",
"type": "string"
},
"id": {
"description": "",
"example": "{{fieldID}}",
"type": "string"
},
"field_type": {
"description": "",
"example": "date",
"type": "string"
},
"slug": {
"description": "",
"example": "start-of-life",
"type": "string"
},
"name": {
"description": "",
"example": "start-of-life",
"type": "string"
},
"description": {
"description": "",
"example": "day the iphone will work",
"type": "string"
},
"required": {
"description": "",
"example": true,
"type": "boolean"
},
"unique": {
"description": "",
"example": false,
"type": "boolean"
},
"default": {
"description": "",
"example": "2018-01-01",
"type": "string"
}
},
"required": [
"type",
"id",
"field_type",
"slug",
"name",
"description",
"required",
"unique",
"default"
]
},
"BuildChildProductsrequest": {
"title": "Build Child ProductsRequest",
"example": {
"data": {
"type": "product-variation",
"name": "Paint colour"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data120"
}
},
"required": [
"data"
]
},
"Data120": {
"title": "Data120",
"example": {
"type": "product-variation",
"name": "Paint colour"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "product-variation",
"type": "string"
},
"name": {
"description": "",
"example": "Paint colour",
"type": "string"
}
},
"required": [
"type",
"name"
]
},
"UpdateProducts<=>FilesRelationshipsrequest": {
"title": "Update Products <=> Files RelationshipsRequest",
"example": {
"data": [
{
"type": "file",
"id": "{{fileID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "file",
"id": "{{fileID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"UpdateACollectionrequest": {
"title": "Update a CollectionRequest",
"example": {
"data": {
"type": "collection",
"id": "{{collectionID",
"name": "Collection #1 Updated",
"slug": "collection-1-update",
"status": "draft",
"description": "first collection updated"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data32"
}
},
"required": [
"data"
]
},
"Stripe card updaterequest": {
"title": "Stripe - Card UpdateRequest",
"example": {
"data": {
"enabled": true,
"login": "xxx"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data126"
}
},
"required": [
"data"
]
},
"Data126": {
"title": "Data126",
"example": {
"enabled": true,
"login": "xxx"
},
"type": "object",
"properties": {
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"login": {
"description": "",
"example": "xxx",
"type": "string"
}
},
"required": [
"enabled",
"login"
]
},
"CreateChildCollectionRelationshipsrequest": {
"title": "Create Child Collection RelationshipsRequest",
"example": {
"data": [
{
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateParentCollectionRelationshiprequest": {
"title": "Create Parent Collection RelationshipRequest",
"example": {
"data": {
"type": "collection",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"UpdateAProductrequest": {
"title": "Update a ProductRequest",
"example": {
"data": {
"type": "product",
"id": "{{productID}}",
"name": "A Product",
"slug": "a-product",
"sku": "SP01-{COLOUR}-new",
"manage_stock": false,
"description": "Some description",
"status": "live",
"commodity_type": "physical",
"price": [
{
"amount": 6999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 7499,
"currency": "USD",
"includes_tax": true
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data132"
}
},
"required": [
"data"
]
},
"Data132": {
"title": "Data132",
"example": {
"type": "product",
"id": "{{productID}}",
"name": "A Product",
"slug": "a-product",
"sku": "SP01-{COLOUR}-new",
"manage_stock": false,
"description": "Some description",
"status": "live",
"commodity_type": "physical",
"price": [
{
"amount": 6999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 7499,
"currency": "USD",
"includes_tax": true
}
]
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "product",
"type": "string"
},
"id": {
"description": "",
"example": "{{productID}}",
"type": "string"
},
"name": {
"description": "",
"example": "A Product",
"type": "string"
},
"slug": {
"description": "",
"example": "a-product",
"type": "string"
},
"sku": {
"description": "",
"example": "SP01-{COLOUR}-new",
"type": "string"
},
"manage_stock": {
"description": "",
"example": false,
"type": "boolean"
},
"description": {
"description": "",
"example": "Some description",
"type": "string"
},
"status": {
"description": "",
"example": "live",
"type": "string"
},
"commodity_type": {
"description": "",
"example": "physical",
"type": "string"
},
"price": {
"description": "",
"example": [
{
"amount": 6999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 7499,
"currency": "USD",
"includes_tax": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Price"
}
}
},
"required": [
"type",
"id",
"name",
"slug",
"sku",
"manage_stock",
"description",
"status",
"commodity_type",
"price"
]
},
"Price": {
"title": "Price",
"example": {
"amount": 6999,
"currency": "GBP",
"includes_tax": true
},
"type": "object",
"properties": {
"amount": {
"description": "",
"example": 6999,
"type": "integer",
"format": "int32"
},
"currency": {
"description": "",
"example": "GBP",
"type": "string"
},
"includes_tax": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"includes_tax"
]
},
"CreateAFieldrequest": {
"title": "Create a fieldRequest",
"example": {
"data": {
"type": "field",
"name": "Product Rating",
"slug": "product-rating",
"field_type": "integer",
"validation_rules": [
{
"type": "between",
"options": {
"from": 1,
"to": 5
}
}
],
"description": "Average rating as given by our users",
"required": false,
"unique": false,
"default": 0,
"enabled": true,
"order": 1,
"relationships": {
"flow": {
"data": {
"type": "flow",
"id": "{{flowID}}"
}
}
}
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data135"
}
},
"required": [
"data"
]
},
"Data135": {
"title": "Data135",
"example": {
"type": "field",
"name": "Product Rating",
"slug": "product-rating",
"field_type": "integer",
"validation_rules": [
{
"type": "between",
"options": {
"from": 1,
"to": 5
}
}
],
"description": "Average rating as given by our users",
"required": false,
"unique": false,
"default": 0,
"enabled": true,
"order": 1,
"relationships": {
"flow": {
"data": {
"type": "flow",
"id": "{{flowID}}"
}
}
}
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "field",
"type": "string"
},
"name": {
"description": "",
"example": "Product Rating",
"type": "string"
},
"slug": {
"description": "",
"example": "product-rating",
"type": "string"
},
"field_type": {
"description": "",
"example": "integer",
"type": "string"
},
"validation_rules": {
"description": "",
"example": [
{
"type": "between",
"options": {
"from": 1,
"to": 5
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ValidationRule"
}
},
"description": {
"description": "",
"example": "Average rating as given by our users",
"type": "string"
},
"required": {
"description": "",
"example": false,
"type": "boolean"
},
"unique": {
"description": "",
"example": false,
"type": "boolean"
},
"default": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"order": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"relationships": {
"$ref": "#/definitions/Relationships"
}
},
"required": [
"type",
"name",
"slug",
"field_type",
"validation_rules",
"description",
"required",
"unique",
"default",
"enabled",
"order",
"relationships"
]
},
"ValidationRule": {
"title": "ValidationRule",
"example": {
"type": "between",
"options": {
"from": 1,
"to": 5
}
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "between",
"type": "string"
},
"options": {
"$ref": "#/definitions/Options"
}
},
"required": [
"type",
"options"
]
},
"Options": {
"title": "Options",
"example": {
"from": 1,
"to": 5
},
"type": "object",
"properties": {
"from": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"to": {
"description": "",
"example": 5,
"type": "integer",
"format": "int32"
}
},
"required": [
"from",
"to"
]
},
"Relationships": {
"title": "Relationships",
"example": {
"flow": {
"data": {
"type": "flow",
"id": "{{flowID}}"
}
}
},
"type": "object",
"properties": {
"flow": {
"$ref": "#/definitions/Flow"
}
},
"required": [
"flow"
]
},
"Flow": {
"title": "Flow",
"example": {
"data": {
"type": "flow",
"id": "{{flowID}}"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data8"
}
},
"required": [
"data"
]
},
"CreateACategoryrequest": {
"title": "Create a CategoryRequest",
"example": {
"data": {
"type": "category",
"name": "Clothing",
"slug": "clothing",
"description": "Browse our clothing line",
"status": "live"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data28"
}
},
"required": [
"data"
]
},
"CreateAProductVariationrequest": {
"title": "Create a Product VariationRequest",
"example": {
"data": {
"type": "product-variation",
"name": "Paint colour"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data120"
}
},
"required": [
"data"
]
},
"DeleteEntryRelationship(s)request": {
"title": "Delete Entry Relationship(s)Request",
"example": {
"data": [
{
"type": "{{RESOURCE_TYPE}}",
"id": "{{RESOURCE_ID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "{{RESOURCE_TYPE}}",
"id": "{{RESOURCE_ID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateABrandrequest": {
"title": "Create a BrandRequest",
"example": {
"data": {
"type": "brand",
"name": "Cool Clothing",
"slug": "cool-clothing",
"description": "Cool clothing make cool clothes!",
"status": "live"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data28"
}
},
"required": [
"data"
]
},
"CreateAPromotionrequest": {
"title": "Create a promotionRequest",
"example": {
"data": {
"type": "promotion",
"name": "Promo #1",
"description": "Initial Promotion",
"enabled": true,
"promotion_type": "fixed_discount",
"schema": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"start": "2017-01-13",
"end": "2018-01-13"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data150"
}
},
"required": [
"data"
]
},
"Data150": {
"title": "Data150",
"example": {
"type": "promotion",
"name": "Promo #1",
"description": "Initial Promotion",
"enabled": true,
"promotion_type": "fixed_discount",
"schema": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"start": "2017-01-13",
"end": "2018-01-13"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "promotion",
"type": "string"
},
"name": {
"description": "",
"example": "Promo #1",
"type": "string"
},
"description": {
"description": "",
"example": "Initial Promotion",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"promotion_type": {
"description": "",
"example": "fixed_discount",
"type": "string"
},
"schema": {
"$ref": "#/definitions/Schema"
},
"start": {
"description": "",
"example": "2017-01-13",
"type": "string"
},
"end": {
"description": "",
"example": "2018-01-13",
"type": "string"
}
},
"required": [
"type",
"name",
"description",
"enabled",
"promotion_type",
"schema",
"start",
"end"
]
},
"UpdateProduct<=>BrandsRelationshipsrequest": {
"title": "Update Product <=> Brands RelationshipsRequest",
"example": {
"data": [
{
"type": "brand",
"id": "{{brandID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "{{brandID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"GenerateACustomerTokenrequest": {
"title": "Generate a customer tokenRequest",
"example": {
"data": {
"type": "token",
"email": "ron@swanson.com",
"password": "mysecretpassword"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data156"
}
},
"required": [
"data"
]
},
"Data156": {
"title": "Data156",
"example": {
"type": "token",
"email": "ron@swanson.com",
"password": "mysecretpassword"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "token",
"type": "string"
},
"email": {
"description": "",
"example": "ron@swanson.com",
"type": "string"
},
"password": {
"description": "",
"example": "mysecretpassword",
"type": "string"
}
},
"required": [
"type",
"email",
"password"
]
},
"CreateBrandRelationshipsrequest": {
"title": "Create Brand RelationshipsRequest",
"example": {
"data": {
"parent": {
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
},
"children": [
{
"type": "brand",
"id": "1334e667-7b2b-4159-9e36-8a3b404901c8"
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data20"
}
},
"required": [
"data"
]
},
"CreateAnIntegrationrequest": {
"title": "Create an IntegrationRequest",
"example": {
"data": {
"type": "integration",
"integration_type": "email",
"enabled": false,
"name": "Emailer",
"description": "email when these things happen",
"observes": [
"product.updated",
"product.created"
],
"configuration": {
"url": "https://demond.com",
"secret_key": "SOME_KEY"
}
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data162"
}
},
"required": [
"data"
]
},
"Data162": {
"title": "Data162",
"example": {
"type": "integration",
"integration_type": "email",
"enabled": false,
"name": "Emailer",
"description": "email when these things happen",
"observes": [
"product.updated",
"product.created"
],
"configuration": {
"url": "https://demond.com",
"secret_key": "SOME_KEY"
}
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "integration",
"type": "string"
},
"integration_type": {
"description": "",
"example": "email",
"type": "string"
},
"enabled": {
"description": "",
"example": false,
"type": "boolean"
},
"name": {
"description": "",
"example": "Emailer",
"type": "string"
},
"description": {
"description": "",
"example": "email when these things happen",
"type": "string"
},
"observes": {
"description": "",
"example": [
"product.updated",
"product.created"
],
"type": "array",
"items": {
"type": "string"
}
},
"configuration": {
"$ref": "#/definitions/Configuration"
}
},
"required": [
"type",
"integration_type",
"enabled",
"name",
"description",
"observes",
"configuration"
]
},
"Configuration": {
"title": "Configuration",
"example": {
"url": "https://demond.com",
"secret_key": "SOME_KEY"
},
"type": "object",
"properties": {
"url": {
"description": "",
"example": "https://demond.com",
"type": "string"
},
"secret_key": {
"description": "",
"example": "SOME_KEY",
"type": "string"
}
},
"required": [
"url",
"secret_key"
]
},
"DeleteProducts<=>BrandsRelationshipsrequest": {
"title": "Delete Products <=> Brands RelationshipsRequest",
"example": {
"data": [
{
"type": "brand",
"id": "{{brandID}}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "brand",
"id": "{{brandID}}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"CreateANewProductrequest": {
"title": "Create a new ProductRequest",
"example": {
"data": {
"type": "product",
"name": "Some Product",
"slug": "some-product-3",
"sku": "SP01-{COLOUR}-3",
"manage_stock": false,
"description": "Some description",
"status": "draft",
"commodity_type": "physical",
"price": [
{
"amount": 5999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 5499,
"currency": "USD",
"includes_tax": true
}
]
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data167"
}
},
"required": [
"data"
]
},
"Data167": {
"title": "Data167",
"example": {
"type": "product",
"name": "Some Product",
"slug": "some-product-3",
"sku": "SP01-{COLOUR}-3",
"manage_stock": false,
"description": "Some description",
"status": "draft",
"commodity_type": "physical",
"price": [
{
"amount": 5999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 5499,
"currency": "USD",
"includes_tax": true
}
]
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "product",
"type": "string"
},
"name": {
"description": "",
"example": "Some Product",
"type": "string"
},
"slug": {
"description": "",
"example": "some-product-3",
"type": "string"
},
"sku": {
"description": "",
"example": "SP01-{COLOUR}-3",
"type": "string"
},
"manage_stock": {
"description": "",
"example": false,
"type": "boolean"
},
"description": {
"description": "",
"example": "Some description",
"type": "string"
},
"status": {
"description": "",
"example": "draft",
"type": "string"
},
"commodity_type": {
"description": "",
"example": "physical",
"type": "string"
},
"price": {
"description": "",
"example": [
{
"amount": 5999,
"currency": "GBP",
"includes_tax": true
},
{
"amount": 5499,
"currency": "USD",
"includes_tax": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Price"
}
}
},
"required": [
"type",
"name",
"slug",
"sku",
"manage_stock",
"description",
"status",
"commodity_type",
"price"
]
},
"CreateEntryRelationship(s)request": {
"title": "Create Entry Relationship(s)Request",
"example": {
"data": [
{
"type": "{RESOURCE_TYPE}",
"id": "{RESOURCE_ID}"
},
{
"type": "{RESOURCE_TYPE}",
"id": "{RESOURCE_ID}"
}
]
},
"type": "object",
"properties": {
"data": {
"description": "",
"example": [
{
"type": "{RESOURCE_TYPE}",
"id": "{RESOURCE_ID}"
},
{
"type": "{RESOURCE_TYPE}",
"id": "{RESOURCE_ID}"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Data8"
}
}
},
"required": [
"data"
]
},
"DeletePromotionrequest": {
"title": "Delete PromotionRequest",
"example": {
"data": {
"type": "promotion",
"name": "Promo #1",
"description": "Initial Promotion",
"enabled": true,
"promotion_type": "fixed_discount",
"schema": {
"currencies": [
{
"currency": "USD",
"amount": 900
},
{
"currency": "GBP",
"amount": 1100
}
]
},
"start": "2017-01-13",
"end": "2018-01-13"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data150"
}
},
"required": [
"data"
]
},
"CreateAProductVariationOptionrequest": {
"title": "Create a Product Variation OptionRequest",
"example": {
"data": {
"type": "option",
"name": "Blue",
"description": "Our most popular color"
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data176"
}
},
"required": [
"data"
]
},
"Data176": {
"title": "Data176",
"example": {
"type": "option",
"name": "Blue",
"description": "Our most popular color"
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "option",
"type": "string"
},
"name": {
"description": "",
"example": "Blue",
"type": "string"
},
"description": {
"description": "",
"example": "Our most popular color",
"type": "string"
}
},
"required": [
"type",
"name",
"description"
]
},
"UpdateAnOrderrequest": {
"title": "Update an orderRequest",
"example": {
"data": {
"type": "order",
"shipping_address": {
"first_name": "John"
}
}
},
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Data178"
}
},
"required": [
"data"
]
},
"Data178": {
"title": "Data178",
"example": {
"type": "order",
"shipping_address": {
"first_name": "John"
}
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "order",
"type": "string"
},
"shipping_address": {
"$ref": "#/definitions/ShippingAddress179"
}
},
"required": [
"type",
"shipping_address"
]
},
"ShippingAddress179": {
"title": "ShippingAddress179",
"example": {
"first_name": "John"
},
"type": "object",
"properties": {
"first_name": {
"description": "",
"example": "John",
"type": "string"
}
},
"required": [
"first_name"
]
}
}
}以上是关于json Moltin OpenAPI的主要内容，如果未能解决你的问题，请参考以下文章
使用 laravel moltin 购物车时的 LaravelSession::insertUpdate() 问题