Skip to content

Instantly share code, notes, and snippets.

@kinlane

kinlane/Ecwid API.json

Created August 16, 2018 23:49
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save kinlane/287afc8940af04bbe6dd1deb2ed31bf6 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save kinlane/287afc8940af04bbe6dd1deb2ed31bf6 to your computer and use it in GitHub Desktop.
Download ZIP
Ecwid API
Raw
Ecwid API.json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Ecwid API v3",
"description": "TODO: Add Description"
},
"host": "app.ecwid.com",
"basePath": "/api/v3/14732441",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/classes": {
"get": {
"description": "",
"summary": "Get all product classes",
"tags": [
"Product Classes"
],
"operationId": "ClassesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/classes?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get all product classes",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create new product class",
"tags": [
"Product Classes"
],
"operationId": "ClassesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateNewProductClassrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/classes?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"T-Shirts\",\"attributes\":[{\"name\":\"Gender\",\"type\":\"CUSTOM\",\"show\":\"DESCR\"},{\"name\":\"Age group\",\"type\":\"CUSTOM\",\"show\":\"DESCR\"},{\"name\":\"Color\",\"type\":\"CUSTOM\",\"show\":\"DESCR\"},{\"name\":\"Size\",\"type\":\"CUSTOM\",\"show\":\"DESCR\"}]}"
},
"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 new product class",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders": {
"get": {
"description": "",
"summary": "Search orders by keywords",
"tags": [
"Orders"
],
"operationId": "OrdersGet9",
"produces": [
"application/json"
],
"parameters": [
{
"name": "keywords",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/orders?keywords=SET-ANY-KEYWORD&token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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": "Search orders by keywords",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new order",
"tags": [
"Orders"
],
"operationId": "OrdersPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewOrderrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/orders?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"subtotal\":30,\"total\":40,\"email\":\"example@example.com\",\"paymentMethod\":\"Phone order\",\"tax\":0,\"paymentStatus\":\"PAID\",\"fulfillmentStatus\":\"AWAITING_PROCESSING\",\"items\":[{\"price\":15,\"weight\":0.32,\"sku\":\"00004\",\"quantity\":2,\"name\":\"Cherry\"}],\"billingPerson\":{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"My Street\",\"city\":\"San Diego\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"123141321\"},\"shippingPerson\":{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"My Street\",\"city\":\"San Diego\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"123141321\"},\"shippingOption\":{\"shippingMethodName\":\"Fast Delivery\",\"shippingRate\":10}}"
},
"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 order",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/customers/SET-CUSTOMER-ID": {
"get": {
"description": "",
"summary": "Get customer details",
"tags": [
"Customers"
],
"operationId": "CustomersSETCUSTOMERIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/customers/SET-CUSTOMER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 customer details",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update / edit a customer",
"tags": [
"Customers"
],
"operationId": "CustomersSETCUSTOMERIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Update~1EditACustomerrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/customers/SET-CUSTOMER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"email\":\"new-email@example.com\",\"password\":\"newpassword\",\"billingPerson\":{\"name\":\"New Name\",\"companyName\":\"Ecwid\",\"street\":\"Updated street\",\"city\":\"Bucket\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"11111111111\"},\"shippingAddresses\":[{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"Hedgehog Street, 3\",\"city\":\"Bucket\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"11111111111\"}]}"
},
"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 / edit a customer",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a customer",
"tags": [
"Customers"
],
"operationId": "CustomersSETCUSTOMERIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/customers/SET-CUSTOMER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a customer",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories": {
"get": {
"description": "",
"summary": "Get all categories",
"tags": [
"Categories"
],
"operationId": "CategoriesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/categories?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 categories",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new category",
"tags": [
"Categories"
],
"operationId": "CategoriesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCategoryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/categories?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"New Cool Category\",\"description\":\"Hey, this is my <b>new</b> category!\",\"enabled\":true,\"orderBy\":10}"
},
"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 category",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/profile": {
"get": {
"description": "",
"summary": "Get a store profile",
"tags": [
"Store Profile"
],
"operationId": "ProfileGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/profile?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 store profile",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update store profile (how to add zones)",
"tags": [
"Store Profile"
],
"operationId": "ProfilePut2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateStoreProfile(howToAddZones)request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/profile?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"zones\":[{\"name\":\"United States - California\",\"countryCodes\":[\"US\"],\"stateOrProvinceCodes\":[\"US-CA\"]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update store profile (how to add zones)",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/profile/logo": {
"post": {
"description": "",
"summary": "Add / upload store logo",
"tags": [
"Store Profile"
],
"operationId": "ProfileLogoPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete store logo",
"tags": [
"Store Profile"
],
"operationId": "ProfileLogoDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/profile/logo?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete store logo",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID": {
"get": {
"description": "",
"summary": "Get product details",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/products/SET-PRODUCT-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 details",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update wholesale prices",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDPut4",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateWholesalePricesrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/products/SET-PRODUCT-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"wholesalePrices\":[{\"quantity\":4,\"price\":11},{\"quantity\":7,\"price\":7}]}"
},
"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 wholesale prices",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a product",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/gallery/SET-GALLERY-IMAGE-ID": {
"delete": {
"description": "",
"summary": "Delete one additional (gallery) product image",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDGallerySETGALLERYIMAGEIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/gallery/SET-GALLERY-IMAGE-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete one additional (gallery) product image",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/combinations": {
"get": {
"description": "",
"summary": "Get all combinations for a product",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/products/SET-PRODUCT-ID/combinations?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 combinations for a product",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new combination",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCombinationrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/products/SET-PRODUCT-ID/combinations?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"options\":[{\"name\":\"Size\",\"value\":\"L\"},{\"name\":\"Color\",\"value\":\"Red\"}],\"price\":10,\"quantity\":4,\"weight\":0.5,\"sku\":\"combination-sku\",\"tangible\":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 combination",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete all combinations",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/combinations?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete all combinations",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/SET-CATEGORY-ID": {
"get": {
"description": "",
"summary": "Get category details",
"tags": [
"Categories"
],
"operationId": "CategoriesSETCATEGORYIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/categories/SET-CATEGORY-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 details",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update / edit a category",
"tags": [
"Categories"
],
"operationId": "CategoriesSETCATEGORYIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Update~1EditACategoryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/categories/SET-CATEGORY-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"Updated name\",\"description\":\"Updated <b>description</b>\",\"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": "Update / edit a category",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a category",
"tags": [
"Categories"
],
"operationId": "CategoriesSETCATEGORYIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/categories/SET-CATEGORY-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a category",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products": {
"get": {
"description": "",
"summary": "Show \"out of stock\" products",
"tags": [
"Products"
],
"operationId": "ProductsGet8",
"produces": [
"application/json"
],
"parameters": [
{
"name": "inStock",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
},
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/products?inStock=false&token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Show \"out of stock\" products",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new product",
"tags": [
"Products"
],
"operationId": "ProductsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/products?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"sku\":\"my-sku-1\",\"unlimited\":false,\"quantity\":10,\"inStock\":true,\"name\":\"New Product\",\"price\":20.99,\"weight\":10,\"enabled\":true,\"description\":\"<b>Description</b>\"}"
},
"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
}
}
},
"/products/SET-PRODUCT-ID/image": {
"post": {
"description": "",
"summary": "Add / Update product image",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDImagePost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete product image",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDImageDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/image?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete product image",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/39622291": {
"put": {
"description": "",
"summary": "Update product options",
"tags": [
"Products"
],
"operationId": "Products39622291Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductOptionsrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/products/39622291?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"options\":[{\"type\":\"RADIO\",\"name\":\"Color\",\"choices\":[{\"text\":\"Red\",\"priceModifier\":0,\"priceModifierType\":\"ABSOLUTE\"},{\"text\":\"Green\",\"priceModifier\":0,\"priceModifierType\":\"ABSOLUTE\"},{\"text\":\"Yellow\",\"priceModifier\":0,\"priceModifierType\":\"ABSOLUTE\"}],\"defaultChoice\":2,\"required\":false},{\"type\":\"SELECT\",\"name\":\"Size\",\"choices\":[{\"text\":\"S\",\"priceModifier\":0,\"priceModifierType\":\"ABSOLUTE\"},{\"text\":\"L\",\"priceModifier\":10,\"priceModifierType\":\"ABSOLUTE\"}],\"defaultChoice\":0,\"required\":false},{\"type\":\"CHECKBOX\",\"name\":\"Additional options?\",\"choices\":[{\"text\":\"Option 1\",\"priceModifier\":5,\"priceModifierType\":\"PERCENT\"},{\"text\":\"Option 2\",\"priceModifier\":-10,\"priceModifierType\":\"ABSOLUTE\"},{\"text\":\"Option 3\",\"priceModifier\":20,\"priceModifierType\":\"PERCENT\"}],\"required\":false},{\"type\":\"TEXTFIELD\",\"name\":\"Name\",\"required\":true},{\"type\":\"TEXTAREA\",\"name\":\"Comments\",\"required\":false},{\"type\":\"DATE\",\"name\":\"Date\",\"required\":false},{\"type\":\"FILES\",\"name\":\"Upload file\",\"required\":true}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update product options",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders/SET-ORDER-ID": {
"get": {
"description": "",
"summary": "Get order details",
"tags": [
"Orders"
],
"operationId": "OrdersSETORDERIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/orders/SET-ORDER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 order details",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update / edit an order",
"tags": [
"Orders"
],
"operationId": "OrdersSETORDERIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Update~1EditAnOrderrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/orders/SET-ORDER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"subtotal\":35,\"total\":45,\"email\":\"newemail@example.com\",\"paymentMethod\":\"New payment method\",\"tax\":0,\"paymentStatus\":\"AWAITING_PAYMENT\",\"fulfillmentStatus\":\"AWAITING_PROCESSING\",\"items\":[{\"price\":20,\"weight\":0.32,\"sku\":\"00004\",\"quantity\":2,\"name\":\"Updated item\"}],\"billingPerson\":{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"My Street\",\"city\":\"San Diego\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"123141321\"},\"shippingPerson\":{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"My Street\",\"city\":\"San Diego\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"123141321\"},\"shippingOption\":{\"shippingMethodName\":\"Fast Delivery\",\"shippingRate\":10}}"
},
"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 / edit an order",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete an order",
"tags": [
"Orders"
],
"operationId": "OrdersSETORDERIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/orders/SET-ORDER-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an order",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/classes/SET-PRODUCT-CLASS-iD": {
"delete": {
"description": "",
"summary": "Delete custom product class",
"tags": [
"Product Classes"
],
"operationId": "ClassesSETPRODUCTCLASSIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/classes/SET-PRODUCT-CLASS-iD?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete custom product class",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/customers": {
"get": {
"description": "",
"summary": "Search customers",
"tags": [
"Customers"
],
"operationId": "CustomersGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "maxOrderCount",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/customers?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY&maxOrderCount=5",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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": "Search customers",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new customer",
"tags": [
"Customers"
],
"operationId": "CustomersPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCustomerrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/customers?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"email\":\"example@example.com\",\"password\":\"ecwidiscool\",\"billingPerson\":{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"Hedgehog Street, 1\",\"city\":\"Bucket\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"11111111111\"},\"shippingAddresses\":[{\"name\":\"Eugene K\",\"companyName\":\"Hedgehog and Bucket\",\"street\":\"Hedgehog Street, 3\",\"city\":\"Bucket\",\"countryCode\":\"US\",\"postalCode\":\"90002\",\"stateOrProvinceCode\":\"CA\",\"phone\":\"11111111111\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new customer",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/gallery": {
"post": {
"description": "",
"summary": "Upload additional (gallery) product image",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDGalleryPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete all additional (gallery) product images",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDGalleryDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/gallery?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete all additional (gallery) product images",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders/SET-ORDER-ID/items/SET-ORDER-ITEM-ID/options/SET-OPTION-NAME": {
"post": {
"description": "",
"summary": "Upload a new product option file for a purchased item",
"tags": [
"Orders"
],
"operationId": "OrdersSETORDERIDItemsSETORDERITEMIDOptionsSETOPTIONNAMEPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "fileName",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/discount_coupons": {
"get": {
"description": "",
"summary": "Get all discount coupons",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "discount_type",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "availability",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/discount_coupons?code=&discount_type=ABS,PERCENT&availability=ACTIVE,EXPIRED&token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY"
},
"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 discount coupons",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a discount coupon",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateADiscountCouponrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/discount_coupons?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"New Coupon - 10$ off\",\"code\":\"UNN9GN6XAW2M\",\"discountType\":\"ABS\",\"status\":\"ACTIVE\",\"discount\":10,\"launchDate\":\"2014-09-01\",\"usesLimit\":\"UNLIMITED\",\"repeatCustomerOnly\":false}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a discount coupon",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/profile/invoicelogo": {
"post": {
"description": "",
"summary": "Add / upload invoice logo",
"tags": [
"Store Profile"
],
"operationId": "ProfileInvoicelogoPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete invoice logo",
"tags": [
"Store Profile"
],
"operationId": "ProfileInvoicelogoDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/profile/invoicelogo?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete invoice logo",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/files": {
"post": {
"description": "",
"summary": "Add product file (e-goods)",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDFilesPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete all product files",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDFilesDelete",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/discount_coupons/SET-COUPON-CODE": {
"get": {
"description": "",
"summary": "Get a discount coupon",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsSETCOUPONCODEGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/discount_coupons/SET-COUPON-CODE?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 discount coupon",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update / edit a discount coupon",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsSETCOUPONCODEPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Update~1EditADiscountCouponrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/discount_coupons/SET-COUPON-CODE?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"Updated name: New Coupon - 30% off\",\"discountType\":\"PERCENT\",\"status\":\"ACTIVE\",\"discount\":30}"
},
"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 / edit a discount coupon",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a discount coupon",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsSETCOUPONCODEDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/discount_coupons/SET-COUPON-CODE?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a discount coupon",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/latest-stats": {
"get": {
"description": "",
"summary": "Get stats about product/order/profile updates",
"tags": [
"Store Profile"
],
"operationId": "LatestStatsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/latest-stats?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 stats about product/order/profile updates",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/discount_coupons/deleted": {
"get": {
"description": "",
"summary": "Get deleted coupons",
"tags": [
"Discount coupons"
],
"operationId": "DiscountCouponsDeletedGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/discount_coupons/deleted?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY"
},
"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 deleted coupons",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders/deleted": {
"get": {
"description": "",
"summary": "Get deleted orders",
"tags": [
"Orders"
],
"operationId": "OrdersDeletedGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/orders/deleted?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 deleted orders",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/classes/0": {
"get": {
"description": "",
"summary": "Get product class details",
"tags": [
"Product Classes"
],
"operationId": "Classes0Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/classes/0?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 class details",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/customers/deleted": {
"get": {
"description": "",
"summary": "Get deleted customers",
"tags": [
"Customers"
],
"operationId": "CustomersDeletedGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/customers/deleted?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 deleted customers",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/files/SET-FILE-ID": {
"delete": {
"description": "",
"summary": "Delete product file",
"tags": [
"Products"
],
"operationId": "ProductsSETPRODUCTIDFilesSETFILEIDDelete",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID": {
"get": {
"description": "",
"summary": "Get a specific combination",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsSETCOMBINATIONIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a specific combination",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a combination",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsSETCOMBINATIONIDPut2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACombinationrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"price\":20,\"quantity\":7,\"weight\":0.7,\"unlimited\":false,\"sku\":\"combo-sku\",\"tangible\":true}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a combination",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a combination",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsSETCOMBINATIONIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a combination",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/classes/SET-PRODUCT-CLASS-ID": {
"put": {
"description": "",
"summary": "Update product class",
"tags": [
"Product Classes"
],
"operationId": "ClassesSETPRODUCTCLASSIDPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductClassrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/classes/SET-PRODUCT-CLASS-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"New Class Name\",\"attributes\":[{\"name\":\"New attribute name\",\"type\":\"CUSTOM\",\"show\":\"DESCR\"}]}"
},
"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 product class",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/categories/SET-CATEGORY-ID/image": {
"post": {
"description": "",
"summary": "Upload / add category icon",
"tags": [
"Categories"
],
"operationId": "CategoriesSETCATEGORYIDImagePost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete category icon",
"tags": [
"Categories"
],
"operationId": "CategoriesSETCATEGORYIDImageDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/categories/SET-CATEGORY-ID/image?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete category icon",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID/image": {
"post": {
"description": "",
"summary": "Add / upload a product combination image",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsSETCOMBINATIONIDImagePost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a product combination image",
"tags": [
"Product Combinations"
],
"operationId": "ProductsSETPRODUCTIDCombinationsSETCOMBINATIONIDImageDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/products/SET-PRODUCT-ID/combinations/SET-COMBINATION-ID/image?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product combination image",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/orders/SET-ORDER-ID/items/SET-ORDER-ITEM-ID/options/SET-OPTION-NAME/files/SET-FILE-ID": {
"delete": {
"description": "",
"summary": "Delete a product option file",
"tags": [
"Orders"
],
"operationId": "OrdersSETORDERIDItemsSETORDERITEMIDOptionsSETOPTIONNAMEFilesSETFILEIDDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/orders/SET-ORDER-ID/items/SET-ORDER-ITEM-ID/options/SET-OPTION-NAME/files/SET-FILE-ID?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a product option file",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/products/deleted": {
"get": {
"description": "",
"summary": "Get deleted products",
"tags": [
"Products"
],
"operationId": "ProductsDeletedGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/products/deleted?token=secret_JFbFRXernkK792AQ53GtYXkN3jWsVzTY",
"headers": {
"Content-Type": "application/json;charset=utf-8"
}
},
"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 deleted products",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"UpdateStoreProfilerequest": {
"title": "Update store profileRequest",
"example": {
"generalInfo": {
"storeUrl": "http://www.example.com/store/"
},
"settings": {
"closed": false,
"storeName": "My Cool Store"
},
"company": {
"companyName": "My Company, Inc",
"email": "store@example.com",
"street": "144 West D Street",
"city": "Encinitas",
"countryCode": "US",
"postalCode": "92024",
"stateOrProvinceCode": "CA",
"phone": "1(800)5555555"
}
},
"type": "object",
"properties": {
"generalInfo": {
"$ref": "#/definitions/GeneralInfo"
},
"settings": {
"$ref": "#/definitions/Settings"
},
"company": {
"$ref": "#/definitions/Company"
}
},
"required": [
"generalInfo",
"settings",
"company"
]
},
"GeneralInfo": {
"title": "GeneralInfo",
"example": {
"storeUrl": "http://www.example.com/store/"
},
"type": "object",
"properties": {
"storeUrl": {
"description": "",
"example": "http://www.example.com/store/",
"type": "string"
}
},
"required": [
"storeUrl"
]
},
"Settings": {
"title": "Settings",
"example": {
"closed": false,
"storeName": "My Cool Store"
},
"type": "object",
"properties": {
"closed": {
"description": "",
"example": false,
"type": "boolean"
},
"storeName": {
"description": "",
"example": "My Cool Store",
"type": "string"
}
},
"required": [
"closed",
"storeName"
]
},
"Company": {
"title": "Company",
"example": {
"companyName": "My Company, Inc",
"email": "store@example.com",
"street": "144 West D Street",
"city": "Encinitas",
"countryCode": "US",
"postalCode": "92024",
"stateOrProvinceCode": "CA",
"phone": "1(800)5555555"
},
"type": "object",
"properties": {
"companyName": {
"description": "",
"example": "My Company, Inc",
"type": "string"
},
"email": {
"description": "",
"example": "store@example.com",
"type": "string"
},
"street": {
"description": "",
"example": "144 West D Street",
"type": "string"
},
"city": {
"description": "",
"example": "Encinitas",
"type": "string"
},
"countryCode": {
"description": "",
"example": "US",
"type": "string"
},
"postalCode": {
"description": "",
"example": "92024",
"type": "string"
},
"stateOrProvinceCode": {
"description": "",
"example": "CA",
"type": "string"
},
"phone": {
"description": "",
"example": "1(800)5555555",
"type": "string"
}
},
"required": [
"companyName",
"email",
"street",
"city",
"countryCode",
"postalCode",
"stateOrProvinceCode",
"phone"
]
},
"CreateNewProductClassrequest": {
"title": "Create new product classRequest",
"example": {
"name": "T-Shirts",
"attributes": [
{
"name": "Gender",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Age group",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Color",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Size",
"type": "CUSTOM",
"show": "DESCR"
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "T-Shirts",
"type": "string"
},
"attributes": {
"description": "",
"example": [
{
"name": "Gender",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Age group",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Color",
"type": "CUSTOM",
"show": "DESCR"
},
{
"name": "Size",
"type": "CUSTOM",
"show": "DESCR"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Attribute"
}
}
},
"required": [
"name",
"attributes"
]
},
"Attribute": {
"title": "Attribute",
"example": {
"name": "Gender",
"type": "CUSTOM",
"show": "DESCR"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Gender",
"type": "string"
},
"type": {
"description": "",
"example": "CUSTOM",
"type": "string"
},
"show": {
"description": "",
"example": "DESCR",
"type": "string"
}
},
"required": [
"name",
"type",
"show"
]
},
"Update/EditAProductrequest": {
"title": "Update / edit a productRequest",
"example": {
"sku": "new-sku-001",
"quantity": 20,
"inStock": false,
"name": "Updated Product",
"price": 30.99,
"listPrice": 44.99,
"weight": 3,
"enabled": true,
"description": "<b>Updated Description</b>"
},
"type": "object",
"properties": {
"sku": {
"description": "",
"example": "new-sku-001",
"type": "string"
},
"quantity": {
"description": "",
"example": 20,
"type": "integer",
"format": "int32"
},
"inStock": {
"description": "",
"example": false,
"type": "boolean"
},
"name": {
"description": "",
"example": "Updated Product",
"type": "string"
},
"price": {
"description": "",
"example": 30.99,
"type": "number",
"format": "double"
},
"listPrice": {
"description": "",
"example": 44.99,
"type": "number",
"format": "double"
},
"weight": {
"description": "",
"example": 3,
"type": "integer",
"format": "int32"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"description": {
"description": "",
"example": "<b>Updated Description</b>",
"type": "string"
}
},
"required": [
"sku",
"quantity",
"inStock",
"name",
"price",
"listPrice",
"weight",
"enabled",
"description"
]
},
"Update/EditACustomerrequest": {
"title": "Update / edit a customerRequest",
"example": {
"email": "new-email@example.com",
"password": "newpassword",
"billingPerson": {
"name": "New Name",
"companyName": "Ecwid",
"street": "Updated street",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
},
"shippingAddresses": [
{
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 3",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
}
]
},
"type": "object",
"properties": {
"email": {
"description": "",
"example": "new-email@example.com",
"type": "string"
},
"password": {
"description": "",
"example": "newpassword",
"type": "string"
},
"billingPerson": {
"$ref": "#/definitions/BillingPerson"
},
"shippingAddresses": {
"description": "",
"example": [
{
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 3",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ShippingAddress"
}
}
},
"required": [
"email",
"password",
"billingPerson",
"shippingAddresses"
]
},
"BillingPerson": {
"title": "BillingPerson",
"example": {
"name": "New Name",
"companyName": "Ecwid",
"street": "Updated street",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "New Name",
"type": "string"
},
"companyName": {
"description": "",
"example": "Ecwid",
"type": "string"
},
"street": {
"description": "",
"example": "Updated street",
"type": "string"
},
"city": {
"description": "",
"example": "Bucket",
"type": "string"
},
"countryCode": {
"description": "",
"example": "US",
"type": "string"
},
"postalCode": {
"description": "",
"example": "90002",
"type": "string"
},
"stateOrProvinceCode": {
"description": "",
"example": "CA",
"type": "string"
},
"phone": {
"description": "",
"example": "11111111111",
"type": "string"
}
},
"required": [
"name",
"companyName",
"street",
"city",
"countryCode",
"postalCode",
"stateOrProvinceCode",
"phone"
]
},
"ShippingAddress": {
"title": "ShippingAddress",
"example": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 3",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Eugene K",
"type": "string"
},
"companyName": {
"description": "",
"example": "Hedgehog and Bucket",
"type": "string"
},
"street": {
"description": "",
"example": "Hedgehog Street, 3",
"type": "string"
},
"city": {
"description": "",
"example": "Bucket",
"type": "string"
},
"countryCode": {
"description": "",
"example": "US",
"type": "string"
},
"postalCode": {
"description": "",
"example": "90002",
"type": "string"
},
"stateOrProvinceCode": {
"description": "",
"example": "CA",
"type": "string"
},
"phone": {
"description": "",
"example": "11111111111",
"type": "string"
}
},
"required": [
"name",
"companyName",
"street",
"city",
"countryCode",
"postalCode",
"stateOrProvinceCode",
"phone"
]
},
"UpdateStoreProfile(howToAddZones)request": {
"title": "Update store profile (how to add zones)Request",
"example": {
"zones": [
{
"name": "United States - California",
"countryCodes": [
"US"
],
"stateOrProvinceCodes": [
"US-CA"
]
}
]
},
"type": "object",
"properties": {
"zones": {
"description": "",
"example": [
{
"name": "United States - California",
"countryCodes": [
"US"
],
"stateOrProvinceCodes": [
"US-CA"
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Zone"
}
}
},
"required": [
"zones"
]
},
"Zone": {
"title": "Zone",
"example": {
"name": "United States - California",
"countryCodes": [
"US"
],
"stateOrProvinceCodes": [
"US-CA"
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "United States - California",
"type": "string"
},
"countryCodes": {
"description": "",
"example": [
"US"
],
"type": "array",
"items": {
"type": "string"
}
},
"stateOrProvinceCodes": {
"description": "",
"example": [
"US-CA"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"countryCodes",
"stateOrProvinceCodes"
]
},
"UpdateProductOptionsrequest": {
"title": "Update product optionsRequest",
"example": {
"options": [
{
"type": "RADIO",
"name": "Color",
"choices": [
{
"text": "Red",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Green",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Yellow",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
}
],
"defaultChoice": 2,
"required": false
},
{
"type": "SELECT",
"name": "Size",
"choices": [
{
"text": "S",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "L",
"priceModifier": 10,
"priceModifierType": "ABSOLUTE"
}
],
"defaultChoice": 0,
"required": false
},
{
"type": "CHECKBOX",
"name": "Additional options?",
"choices": [
{
"text": "Option 1",
"priceModifier": 5,
"priceModifierType": "PERCENT"
},
{
"text": "Option 2",
"priceModifier": -10,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Option 3",
"priceModifier": 20,
"priceModifierType": "PERCENT"
}
],
"required": false
},
{
"type": "TEXTFIELD",
"name": "Name",
"required": true
},
{
"type": "TEXTAREA",
"name": "Comments",
"required": false
},
{
"type": "DATE",
"name": "Date",
"required": false
},
{
"type": "FILES",
"name": "Upload file",
"required": true
}
]
},
"type": "object",
"properties": {
"options": {
"description": "",
"example": [
{
"type": "RADIO",
"name": "Color",
"choices": [
{
"text": "Red",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Green",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Yellow",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
}
],
"defaultChoice": 2,
"required": false
},
{
"type": "SELECT",
"name": "Size",
"choices": [
{
"text": "S",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "L",
"priceModifier": 10,
"priceModifierType": "ABSOLUTE"
}
],
"defaultChoice": 0,
"required": false
},
{
"type": "CHECKBOX",
"name": "Additional options?",
"choices": [
{
"text": "Option 1",
"priceModifier": 5,
"priceModifierType": "PERCENT"
},
{
"text": "Option 2",
"priceModifier": -10,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Option 3",
"priceModifier": 20,
"priceModifierType": "PERCENT"
}
],
"required": false
},
{
"type": "TEXTFIELD",
"name": "Name",
"required": true
},
{
"type": "TEXTAREA",
"name": "Comments",
"required": false
},
{
"type": "DATE",
"name": "Date",
"required": false
},
{
"type": "FILES",
"name": "Upload file",
"required": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
}
},
"required": [
"options"
]
},
"Option": {
"title": "Option",
"example": {
"type": "RADIO",
"name": "Color",
"choices": [
{
"text": "Red",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Green",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Yellow",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
}
],
"defaultChoice": 2,
"required": false
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "RADIO",
"type": "string"
},
"name": {
"description": "",
"example": "Color",
"type": "string"
},
"required": {
"description": "",
"example": false,
"type": "boolean"
},
"choices": {
"description": "",
"example": [
{
"text": "Red",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Green",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
{
"text": "Yellow",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Choice"
}
},
"defaultChoice": {
"description": "",
"example": 2,
"type": "integer",
"format": "int32"
}
},
"required": [
"type",
"name",
"required"
]
},
"Choice": {
"title": "Choice",
"example": {
"text": "Red",
"priceModifier": 0,
"priceModifierType": "ABSOLUTE"
},
"type": "object",
"properties": {
"text": {
"description": "",
"example": "Red",
"type": "string"
},
"priceModifier": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"priceModifierType": {
"description": "",
"example": "ABSOLUTE",
"type": "string"
}
},
"required": [
"text",
"priceModifier",
"priceModifierType"
]
},
"CreateANewCombinationrequest": {
"title": "Create a new combinationRequest",
"example": {
"options": [
{
"name": "Size",
"value": "L"
},
{
"name": "Color",
"value": "Red"
}
],
"price": 10,
"quantity": 4,
"weight": 0.5,
"sku": "combination-sku",
"tangible": true
},
"type": "object",
"properties": {
"options": {
"description": "",
"example": [
{
"name": "Size",
"value": "L"
},
{
"name": "Color",
"value": "Red"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option16"
}
},
"price": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"quantity": {
"description": "",
"example": 4,
"type": "integer",
"format": "int32"
},
"weight": {
"description": "",
"example": 0.5,
"type": "number",
"format": "double"
},
"sku": {
"description": "",
"example": "combination-sku",
"type": "string"
},
"tangible": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"options",
"price",
"quantity",
"weight",
"sku",
"tangible"
]
},
"Option16": {
"title": "Option16",
"example": {
"name": "Size",
"value": "L"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Size",
"type": "string"
},
"value": {
"description": "",
"example": "L",
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"Update/EditACategoryrequest": {
"title": "Update / edit a categoryRequest",
"example": {
"name": "Updated name",
"description": "Updated <b>description</b>",
"enabled": true
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Updated name",
"type": "string"
},
"description": {
"description": "",
"example": "Updated <b>description</b>",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"name",
"description",
"enabled"
]
},
"CreateANewCategoryrequest": {
"title": "Create a new categoryRequest",
"example": {
"name": "New Cool Category",
"description": "Hey, this is my <b>new</b> category!",
"enabled": true,
"orderBy": 10
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "New Cool Category",
"type": "string"
},
"description": {
"description": "",
"example": "Hey, this is my <b>new</b> category!",
"type": "string"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"orderBy": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
}
},
"required": [
"name",
"description",
"enabled",
"orderBy"
]
},
"UpdateWholesalePricesOfACombinationrequest": {
"title": "Update wholesale prices of a combinationRequest",
"example": {
"wholesalePrices": [
{
"quantity": 4,
"price": 10
},
{
"quantity": 9,
"price": 9
}
]
},
"type": "object",
"properties": {
"wholesalePrices": {
"description": "",
"example": [
{
"quantity": 4,
"price": 10
},
{
"quantity": 9,
"price": 9
}
],
"type": "array",
"items": {
"$ref": "#/definitions/WholesalePrice"
}
}
},
"required": [
"wholesalePrices"
]
},
"WholesalePrice": {
"title": "WholesalePrice",
"example": {
"quantity": 4,
"price": 10
},
"type": "object",
"properties": {
"quantity": {
"description": "",
"example": 4,
"type": "integer",
"format": "int32"
},
"price": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
}
},
"required": [
"quantity",
"price"
]
},
"UpdateProductClassrequest": {
"title": "Update product classRequest",
"example": {
"name": "New Class Name",
"attributes": [
{
"name": "New attribute name",
"type": "CUSTOM",
"show": "DESCR"
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "New Class Name",
"type": "string"
},
"attributes": {
"description": "",
"example": [
{
"name": "New attribute name",
"type": "CUSTOM",
"show": "DESCR"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Attribute"
}
}
},
"required": [
"name",
"attributes"
]
},
"UpdateACombinationrequest": {
"title": "Update a combinationRequest",
"example": {
"price": 20,
"quantity": 7,
"weight": 0.7,
"unlimited": false,
"sku": "combo-sku",
"tangible": true
},
"type": "object",
"properties": {
"price": {
"description": "",
"example": 20,
"type": "integer",
"format": "int32"
},
"quantity": {
"description": "",
"example": 7,
"type": "integer",
"format": "int32"
},
"weight": {
"description": "",
"example": 0.7,
"type": "number",
"format": "double"
},
"unlimited": {
"description": "",
"example": false,
"type": "boolean"
},
"sku": {
"description": "",
"example": "combo-sku",
"type": "string"
},
"tangible": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"price",
"quantity",
"weight",
"unlimited",
"sku",
"tangible"
]
},
"CreateANewOrderrequest": {
"title": "Create a new orderRequest",
"example": {
"subtotal": 30,
"total": 40,
"email": "example@example.com",
"paymentMethod": "Phone order",
"tax": 0,
"paymentStatus": "PAID",
"fulfillmentStatus": "AWAITING_PROCESSING",
"items": [
{
"price": 15,
"weight": 0.32,
"sku": "00004",
"quantity": 2,
"name": "Cherry"
}
],
"billingPerson": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "My Street",
"city": "San Diego",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "123141321"
},
"shippingPerson": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "My Street",
"city": "San Diego",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "123141321"
},
"shippingOption": {
"shippingMethodName": "Fast Delivery",
"shippingRate": 10
}
},
"type": "object",
"properties": {
"subtotal": {
"description": "",
"example": 30,
"type": "integer",
"format": "int32"
},
"total": {
"description": "",
"example": 40,
"type": "integer",
"format": "int32"
},
"email": {
"description": "",
"example": "example@example.com",
"type": "string"
},
"paymentMethod": {
"description": "",
"example": "Phone order",
"type": "string"
},
"tax": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"paymentStatus": {
"description": "",
"example": "PAID",
"type": "string"
},
"fulfillmentStatus": {
"description": "",
"example": "AWAITING_PROCESSING",
"type": "string"
},
"items": {
"description": "",
"example": [
{
"price": 15,
"weight": 0.32,
"sku": "00004",
"quantity": 2,
"name": "Cherry"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Item"
}
},
"billingPerson": {
"$ref": "#/definitions/BillingPerson"
},
"shippingPerson": {
"$ref": "#/definitions/ShippingPerson"
},
"shippingOption": {
"$ref": "#/definitions/ShippingOption"
}
},
"required": [
"subtotal",
"total",
"email",
"paymentMethod",
"tax",
"paymentStatus",
"fulfillmentStatus",
"items",
"billingPerson",
"shippingPerson",
"shippingOption"
]
},
"Item": {
"title": "Item",
"example": {
"price": 15,
"weight": 0.32,
"sku": "00004",
"quantity": 2,
"name": "Cherry"
},
"type": "object",
"properties": {
"price": {
"description": "",
"example": 15,
"type": "integer",
"format": "int32"
},
"weight": {
"description": "",
"example": 0.32,
"type": "number",
"format": "double"
},
"sku": {
"description": "",
"example": "00004",
"type": "string"
},
"quantity": {
"description": "",
"example": 2,
"type": "integer",
"format": "int32"
},
"name": {
"description": "",
"example": "Cherry",
"type": "string"
}
},
"required": [
"price",
"weight",
"sku",
"quantity",
"name"
]
},
"ShippingPerson": {
"title": "ShippingPerson",
"example": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "My Street",
"city": "San Diego",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "123141321"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Eugene K",
"type": "string"
},
"companyName": {
"description": "",
"example": "Hedgehog and Bucket",
"type": "string"
},
"street": {
"description": "",
"example": "My Street",
"type": "string"
},
"city": {
"description": "",
"example": "San Diego",
"type": "string"
},
"countryCode": {
"description": "",
"example": "US",
"type": "string"
},
"postalCode": {
"description": "",
"example": "90002",
"type": "string"
},
"stateOrProvinceCode": {
"description": "",
"example": "CA",
"type": "string"
},
"phone": {
"description": "",
"example": "123141321",
"type": "string"
}
},
"required": [
"name",
"companyName",
"street",
"city",
"countryCode",
"postalCode",
"stateOrProvinceCode",
"phone"
]
},
"ShippingOption": {
"title": "ShippingOption",
"example": {
"shippingMethodName": "Fast Delivery",
"shippingRate": 10
},
"type": "object",
"properties": {
"shippingMethodName": {
"description": "",
"example": "Fast Delivery",
"type": "string"
},
"shippingRate": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
}
},
"required": [
"shippingMethodName",
"shippingRate"
]
},
"Update/EditAnOrderrequest": {
"title": "Update / edit an orderRequest",
"example": {
"subtotal": 35,
"total": 45,
"email": "newemail@example.com",
"paymentMethod": "New payment method",
"tax": 0,
"paymentStatus": "AWAITING_PAYMENT",
"fulfillmentStatus": "AWAITING_PROCESSING",
"items": [
{
"price": 20,
"weight": 0.32,
"sku": "00004",
"quantity": 2,
"name": "Updated item"
}
],
"billingPerson": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "My Street",
"city": "San Diego",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "123141321"
},
"shippingPerson": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "My Street",
"city": "San Diego",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "123141321"
},
"shippingOption": {
"shippingMethodName": "Fast Delivery",
"shippingRate": 10
}
},
"type": "object",
"properties": {
"subtotal": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"total": {
"description": "",
"example": 45,
"type": "integer",
"format": "int32"
},
"email": {
"description": "",
"example": "newemail@example.com",
"type": "string"
},
"paymentMethod": {
"description": "",
"example": "New payment method",
"type": "string"
},
"tax": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"paymentStatus": {
"description": "",
"example": "AWAITING_PAYMENT",
"type": "string"
},
"fulfillmentStatus": {
"description": "",
"example": "AWAITING_PROCESSING",
"type": "string"
},
"items": {
"description": "",
"example": [
{
"price": 20,
"weight": 0.32,
"sku": "00004",
"quantity": 2,
"name": "Updated item"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Item"
}
},
"billingPerson": {
"$ref": "#/definitions/BillingPerson"
},
"shippingPerson": {
"$ref": "#/definitions/ShippingPerson"
},
"shippingOption": {
"$ref": "#/definitions/ShippingOption"
}
},
"required": [
"subtotal",
"total",
"email",
"paymentMethod",
"tax",
"paymentStatus",
"fulfillmentStatus",
"items",
"billingPerson",
"shippingPerson",
"shippingOption"
]
},
"CreateANewCustomerrequest": {
"title": "Create a new customerRequest",
"example": {
"email": "example@example.com",
"password": "ecwidiscool",
"billingPerson": {
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 1",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
},
"shippingAddresses": [
{
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 3",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
}
]
},
"type": "object",
"properties": {
"email": {
"description": "",
"example": "example@example.com",
"type": "string"
},
"password": {
"description": "",
"example": "ecwidiscool",
"type": "string"
},
"billingPerson": {
"$ref": "#/definitions/BillingPerson"
},
"shippingAddresses": {
"description": "",
"example": [
{
"name": "Eugene K",
"companyName": "Hedgehog and Bucket",
"street": "Hedgehog Street, 3",
"city": "Bucket",
"countryCode": "US",
"postalCode": "90002",
"stateOrProvinceCode": "CA",
"phone": "11111111111"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ShippingAddress"
}
}
},
"required": [
"email",
"password",
"billingPerson",
"shippingAddresses"
]
},
"UpdateWholesalePricesrequest": {
"title": "Update wholesale pricesRequest",
"example": {
"wholesalePrices": [
{
"quantity": 4,
"price": 11
},
{
"quantity": 7,
"price": 7
}
]
},
"type": "object",
"properties": {
"wholesalePrices": {
"description": "",
"example": [
{
"quantity": 4,
"price": 11
},
{
"quantity": 7,
"price": 7
}
],
"type": "array",
"items": {
"$ref": "#/definitions/WholesalePrice"
}
}
},
"required": [
"wholesalePrices"
]
},
"CreateANewProductrequest": {
"title": "Create a new productRequest",
"example": {
"sku": "my-sku-1",
"unlimited": false,
"quantity": 10,
"inStock": true,
"name": "New Product",
"price": 20.99,
"weight": 10,
"enabled": true,
"description": "<b>Description</b>"
},
"type": "object",
"properties": {
"sku": {
"description": "",
"example": "my-sku-1",
"type": "string"
},
"unlimited": {
"description": "",
"example": false,
"type": "boolean"
},
"quantity": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"inStock": {
"description": "",
"example": true,
"type": "boolean"
},
"name": {
"description": "",
"example": "New Product",
"type": "string"
},
"price": {
"description": "",
"example": 20.99,
"type": "number",
"format": "double"
},
"weight": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"enabled": {
"description": "",
"example": true,
"type": "boolean"
},
"description": {
"description": "",
"example": "<b>Description</b>",
"type": "string"
}
},
"required": [
"sku",
"unlimited",
"quantity",
"inStock",
"name",
"price",
"weight",
"enabled",
"description"
]
},
"CreateADiscountCouponrequest": {
"title": "Create a discount couponRequest",
"example": {
"name": "New Coupon - 10$ off",
"code": "UNN9GN6XAW2M",
"discountType": "ABS",
"status": "ACTIVE",
"discount": 10,
"launchDate": "2014-09-01",
"usesLimit": "UNLIMITED",
"repeatCustomerOnly": false
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "New Coupon - 10$ off",
"type": "string"
},
"code": {
"description": "",
"example": "UNN9GN6XAW2M",
"type": "string"
},
"discountType": {
"description": "",
"example": "ABS",
"type": "string"
},
"status": {
"description": "",
"example": "ACTIVE",
"type": "string"
},
"discount": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"launchDate": {
"description": "",
"example": "2014-09-01",
"type": "string"
},
"usesLimit": {
"description": "",
"example": "UNLIMITED",
"type": "string"
},
"repeatCustomerOnly": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"name",
"code",
"discountType",
"status",
"discount",
"launchDate",
"usesLimit",
"repeatCustomerOnly"
]
},
"Update/EditADiscountCouponrequest": {
"title": "Update / edit a discount couponRequest",
"example": {
"name": "Updated name: New Coupon - 30% off",
"discountType": "PERCENT",
"status": "ACTIVE",
"discount": 30
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Updated name: New Coupon - 30% off",
"type": "string"
},
"discountType": {
"description": "",
"example": "PERCENT",
"type": "string"
},
"status": {
"description": "",
"example": "ACTIVE",
"type": "string"
},
"discount": {
"description": "",
"example": 30,
"type": "integer",
"format": "int32"
}
},
"required": [
"name",
"discountType",
"status",
"discount"
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment