{"data":{"allRamlResource":{"nodes":[{"apiKey":"api","resourceName":"ByProjectKey","resourcePathUri":"/{projectKey}","description":"The Project endpoint is used to retrieve certain information from a project.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_project:{projectKey}"]}}],"displayName":"Update project settings","description":"Update project","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Project","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ProjectUpdate","builtinType":"object"}}},"put":null,"patch":{"securedBy":[{"oauth_2_0":{"scopes":["manage_project:{projectKey}"]}}],"displayName":"Update project settings","description":"Update project","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Project","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ProjectUpdate","builtinType":"object"}}},"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_project:{projectKey}"]}}],"displayName":"Get project settings","description":"The Endpoint is responding a limited set of information about settings and configuration of the project.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Project","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":{"securedBy":[{"oauth_2_0":{"scopes":["manage_project:{projectKey}"]}}],"displayName":"Check for project existence","description":"Check if there is a project matching the given key.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Project","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X HEAD https://api.{region}.commercetools.com/{projectKey} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyApiClients","resourcePathUri":"/{projectKey}/api-clients","description":"Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_api_clients:{projectKey}"]}}],"displayName":"Create ApiClient","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ApiClient","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/api-clients -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : \"api-client-name\",\n  \"scope\" : \"view_products\"\n}\nDATA"}],"body":{"applicationjson":{"type":"ApiClientDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_api_clients:{projectKey}","view_api_clients:{projectKey}"]}}],"displayName":"Query api-clients","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ApiClientPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/api-clients -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyApiClientsById","resourcePathUri":"/{projectKey}/api-clients/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_api_clients:{projectKey}","view_api_clients:{projectKey}"]}}],"displayName":"Get ApiClient by ID","description":"Get ApiClient by ID","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ApiClient","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/api-clients/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_api_clients:{projectKey}"]}}],"displayName":"Delete ApiClient by ID","description":"Delete ApiClient by ID","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ApiClient","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/api-clients/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCartDiscounts","resourcePathUri":"/{projectKey}/cart-discounts","description":"Cart discounts are used to change the prices of different elements within a cart.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_cart_discounts:{projectKey}"]}}],"displayName":"Create CartDiscount","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/cart-discounts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"Summer Sale\"\n  },\n  \"value\" : {\n    \"type\" : \"relative\",\n    \"permyriad\" : 1000\n  },\n  \"cartPredicate\" : \"1=1\",\n  \"target\" : {\n    \"type\" : \"lineItems\",\n    \"predicate\" : \"1=1\"\n  },\n  \"sortOrder\" : \"0.1\",\n  \"isActive\" : true,\n  \"requiresDiscountCode\" : false\n}\nDATA"}],"body":{"applicationjson":{"type":"CartDiscountDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_cart_discounts:{projectKey}"]}}],"displayName":"Query cart-discounts","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscountPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/cart-discounts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCartDiscountsById","resourcePathUri":"/{projectKey}/cart-discounts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [CartDiscount](ctp:api:type:CartDiscount).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_cart_discounts:{projectKey}"]}}],"displayName":"Update CartDiscount by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeValue\",\n    \"value\" : {\n      \"type\" : \"relative\",\n      \"permyriad\" : 1000\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartDiscountUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_cart_discounts:{projectKey}"]}}],"displayName":"Get CartDiscount by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_cart_discounts:{projectKey}"]}}],"displayName":"Delete CartDiscount by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCartDiscountsKeyByKey","resourcePathUri":"/{projectKey}/cart-discounts/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [CartDiscount](ctp:api:type:CartDiscount).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_cart_discounts:{projectKey}"]}}],"displayName":"Update CartDiscount by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeValue\",\n    \"value\" : {\n      \"type\" : \"relative\",\n      \"permyriad\" : 1000\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartDiscountUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_cart_discounts:{projectKey}"]}}],"displayName":"Get CartDiscount by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_cart_discounts:{projectKey}"]}}],"displayName":"Delete CartDiscount by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCarts","resourcePathUri":"/{projectKey}/carts","description":"A shopping cart holds product variants and can be ordered.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Create Cart","description":"Creating a cart can fail with an InvalidOperation if the referenced shipping method in the\nCartDraft has a predicate which does not match the cart.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"currency\" : \"EUR\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Query carts","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"customerId","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCartsById","resourcePathUri":"/{projectKey}/carts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Cart by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Cart by id","description":"The cart may not contain up-to-date prices, discounts etc.\nIf you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Cart by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/carts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCartsCustomerIdByCustomerId","resourcePathUri":"/{projectKey}/carts/customer-id={customerId}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"customerid","type":"string","builtinType":"string","description":"`customerId` of the [Cart](ctp:api:type:Cart).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Cart by customerId","description":"Retrieves the active cart of the customer that has been modified most recently.\nIt does not consider carts with CartOrigin Merchant. If no active cart exists, a 404 Not Found error is returned.\n\nThe cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date,\nsend an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/carts/customer-id={customerId} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCartsKeyByKey","resourcePathUri":"/{projectKey}/carts/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Cart by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Cart by key","description":"The cart may not contain up-to-date prices, discounts etc.\nIf you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Cart by key","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/carts/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCartsReplicate","resourcePathUri":"/{projectKey}/carts/replicate","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Replicate cart","description":null,"queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ReplicaCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCategories","resourcePathUri":"/{projectKey}/categories","description":"Categories are used to organize products in a hierarchical structure.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","view_categories:{projectKey}"]}}],"displayName":"Create Category","description":"Creating a category produces the CategoryCreated message.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/categories -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"Top hat\"\n  },\n  \"slug\" : {\n    \"en\" : \"top-hat\"\n  },\n  \"orderHint\" : \"0.1\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CategoryDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_categories:{projectKey}"]}}],"displayName":"Query categories","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CategoryPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/categories -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCategoriesById","resourcePathUri":"/{projectKey}/categories/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Category](ctp:api:type:Category).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_categories:{projectKey}"]}}],"displayName":"Update Category by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/categories/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CategoryUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_categories:{projectKey}"]}}],"displayName":"Get Category by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/categories/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_categories:{projectKey}"]}}],"displayName":"Delete Category by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/categories/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCategoriesKeyByKey","resourcePathUri":"/{projectKey}/categories/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Category](ctp:api:type:Category).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_categories:{projectKey}"]}}],"displayName":"Update Category by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/categories/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CategoryUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_categories:{projectKey}"]}}],"displayName":"Get Category by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/categories/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_categories:{projectKey}"]}}],"displayName":"Delete Category by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Category","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/categories/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyChannels","resourcePathUri":"/{projectKey}/channels","description":"Channels represent a source or destination of different entities. They can be used to model warehouses or stores.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create Channel","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Channel","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/channels -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"commercetools\",\n  \"roles\" : [ \"InventorySupply\" ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ChannelDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query channels","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ChannelPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/channels -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyChannelsById","resourcePathUri":"/{projectKey}/channels/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Channel](ctp:api:type:Channel).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update Channel by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Channel","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/channels/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ChannelUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get Channel by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Channel","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/channels/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete Channel by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Channel","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/channels/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomObjects","resourcePathUri":"/{projectKey}/custom-objects","description":"Store custom JSON values.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_orders:{projectKey}","manage_customers:{projectKey}"]}}],"displayName":"Create CustomObject","description":"Creates a new custom object or updates an existing custom object.\nIf an object with the given container/key exists,\nthe object will be replaced with the new value and the version is incremented.\nIf the request contains a version and an object with the given container/key exists then the version\nmust match the version of the existing object. Concurrent updates for the same custom object still can result\nin a Conflict (409) even if the version is not provided.\nFields with null values will not be saved.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomObject","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/custom-objects -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"container\" : \"test-container\",\n  \"key\" : \"test-key\",\n  \"value\" : \"test-value\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomObjectDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_orders:{projectKey}","view_customers:{projectKey}"]}}],"displayName":"Query custom-objects","description":"The query endpoint allows to retrieve custom objects in a specific container or all custom objects.\nFor performance reasons, it is highly advisable to query only for custom objects in a container by using\nthe container field in the where predicate.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomObjectPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/custom-objects -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomObjectsByContainer","resourcePathUri":"/{projectKey}/custom-objects/{container}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"container","type":"string","builtinType":"string","description":"`container` of the [CustomObjectPagedQueryResponse](ctp:api:type:CustomObjectPagedQueryResponse).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_orders:{projectKey}","view_customers:{projectKey}"]}}],"displayName":"Get CustomObjectPagedQueryResponse by container","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomObjectPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/custom-objects/{container} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomObjectsByContainerByKey","resourcePathUri":"/{projectKey}/custom-objects/{container}/{key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"container","type":"string","builtinType":"string","description":null,"required":true},{"name":"key","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_orders:{projectKey}","view_customers:{projectKey}"]}}],"displayName":"Get CustomObject by container and key","description":"Get CustomObject by container and key","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomObject","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/custom-objects/{container}/{key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_orders:{projectKey}","manage_customers:{projectKey}"]}}],"displayName":"Delete CustomObject by container and key","description":"Delete CustomObject by container and key","queryParameters":[{"name":"version","required":false,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomObject","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/custom-objects/{container}/{key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomerGroups","resourcePathUri":"/{projectKey}/customer-groups","description":"customer-groups are used to evaluate products and channels.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customer_groups:{projectKey}"]}}],"displayName":"Create CustomerGroup","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"groupName\" : \"Webshop user\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerGroupDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customer_groups:{projectKey}"]}}],"displayName":"Query customer-groups","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":"Queryable field: `name`","items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroupPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomerGroupsById","resourcePathUri":"/{projectKey}/customer-groups/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [CustomerGroup](ctp:api:type:CustomerGroup).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customer_groups:{projectKey}"]}}],"displayName":"Update CustomerGroup by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerGroupUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customer_groups:{projectKey}"]}}],"displayName":"Get CustomerGroup by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customer_groups:{projectKey}"]}}],"displayName":"Delete CustomerGroup by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomerGroupsKeyByKey","resourcePathUri":"/{projectKey}/customer-groups/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [CustomerGroup](ctp:api:type:CustomerGroup).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customer_groups:{projectKey}"]}}],"displayName":"Update CustomerGroup by key","description":"","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerGroupUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customer_groups:{projectKey}"]}}],"displayName":"Get CustomerGroup by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customer_groups:{projectKey}"]}}],"displayName":"Delete CustomerGroup by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerGroup","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomers","resourcePathUri":"/{projectKey}/customers","description":"A customer is a person purchasing products. customers, Orders, Comments and Reviews can be associated to a customer.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Create Customer","description":"Creates a customer. If an anonymous cart is passed in,\nthen the cart is assigned to the created customer and the version number of the Cart will increase.\nIf the ID of an anonymous session is given, all carts and orders will be assigned to the created customer.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customers -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"email\" : \"<random>@example.com\",\n  \"firstName\" : \"John\",\n  \"lastName\" : \"Doe\",\n  \"password\" : \"secret123\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}"]}}],"displayName":"Query customers","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customers -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersById","resourcePathUri":"/{projectKey}/customers/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Customer](ctp:api:type:Customer).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Update Customer by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customers/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"addAddress\",\n    \"address\" : {\n      \"streetName\" : \"Any Street\",\n      \"streetNumber\" : \"1337\",\n      \"postalCode\" : \"11111\",\n      \"city\" : \"Any City\",\n      \"country\" : \"US\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}"]}}],"displayName":"Get Customer by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customers/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Delete Customer by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customers/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomersEmailConfirm","resourcePathUri":"/{projectKey}/customers/email/confirm","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Verifies customer's email.","description":"Verifies customer's email using a token.","queryParameters":null,"responses":[{"code":200,"description":"The email was verified.","body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerEmailVerify","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersEmailToken","resourcePathUri":"/{projectKey}/customers/email-token","description":"To verify a customer's email, an email token can be created. This should be embedded in a link and sent to the\ncustomer via email. When the customer clicks on the link, the \"verify customer's email\" endpoint should be called,\nwhich sets customer's isVerifiedEmail field to true.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Create a Token for verifying the Customer's Email","description":"Create a Token for verifying the Customer's Email","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerToken","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerCreateEmailToken","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersEmailTokenByEmailToken","resourcePathUri":"/{projectKey}/customers/email-token={emailToken}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"emailToken","type":"string","builtinType":"string","description":"`emailToken` of the [Customer](ctp:api:type:Customer).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}"]}}],"displayName":"Get customer by email verification token","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customers/email-token={emailToken} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersKeyByKey","resourcePathUri":"/{projectKey}/customers/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Customer](ctp:api:type:Customer).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Update Customer by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/customers/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"addAddress\",\n    \"address\" : {\n      \"streetName\" : \"Any Street\",\n      \"streetNumber\" : \"1337\",\n      \"postalCode\" : \"11111\",\n      \"city\" : \"Any City\",\n      \"country\" : \"US\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}"]}}],"displayName":"Get Customer by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customers/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Delete Customer by key","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customers/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyCustomersPassword","resourcePathUri":"/{projectKey}/customers/password","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Change a customers password","description":"Change a customers password","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerChangePassword","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersPasswordReset","resourcePathUri":"/{projectKey}/customers/password/reset","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Reset Customer's Password","description":"Set a new password using a token.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerResetPassword","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersPasswordToken","resourcePathUri":"/{projectKey}/customers/password-token","description":"The following workflow can be used to reset the customer's password:\n\n* Create a password reset token and send it embedded in a link to the customer.\n* When the customer clicks on the link, the customer is retrieved with the token.\n* The customer enters a new password and the \"reset customer's password\" endpoint is called.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Create a Token for Resetting the Customer's Password","description":"The token value is used to reset the password of the customer with the given email. The token is\nvalid only for 10 minutes.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerToken","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerCreatePasswordResetToken","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyCustomersPasswordTokenByPasswordToken","resourcePathUri":"/{projectKey}/customers/password-token={passwordToken}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"passwordToken","type":"string","builtinType":"string","description":"`passwordToken` of the [Customer](ctp:api:type:Customer).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}"]}}],"displayName":"Get customer by password verification token","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/customers/password-token={passwordToken} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyDiscountCodes","resourcePathUri":"/{projectKey}/discount-codes","description":"Discount codes can be added to a discount-code to enable certain discount-code discounts.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Create DiscountCode","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"DiscountCode","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/discount-codes -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"code\" : \"SAVE10\",\n  \"name\" : {\n    \"en\" : \"Save10\"\n  },\n  \"cartDiscounts\" : [ {\n    \"typeId\" : \"cart-discount\",\n    \"id\" : \"fdbaf4ea-fbc9-4fea-bac4-1d7e6c1995b3\"\n  } ],\n  \"isActive\" : true,\n  \"cartPredicate\" : \"1=1\"\n}\nDATA"}],"body":{"applicationjson":{"type":"DiscountCodeDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Query discount-codes","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"DiscountCodePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/discount-codes -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyDiscountCodesById","resourcePathUri":"/{projectKey}/discount-codes/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [DiscountCode](ctp:api:type:DiscountCode).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update DiscountCode by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"DiscountCode","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/discount-codes/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"DiscountCodeUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get DiscountCode by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"DiscountCode","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/discount-codes/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete DiscountCode by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"DiscountCode","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/discount-codes/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyExtensions","resourcePathUri":"/{projectKey}/extensions","description":"Extend the behavior of an API with your business logic","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Create Extension","description":"Currently, a maximum of 25 extensions can be created per project.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/extensions -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"destination\" : {\n    \"type\" : \"HTTP\",\n    \"url\" : \"https://example.azurewebsites.net/api/extension\",\n    \"authentication\" : {\n      \"type\" : \"AzureFunctions\",\n      \"key\" : \"some-azure-function-code\"\n    }\n  },\n  \"triggers\" : [ {\n    \"resourceTypeId\" : \"cart\",\n    \"actions\" : [ \"Create\", \"Update\" ]\n  } ],\n  \"key\" : \"my-extension\"\n}\nDATA"}],"body":{"applicationjson":{"type":"ExtensionDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Query extensions","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ExtensionPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/extensions -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyExtensionsById","resourcePathUri":"/{projectKey}/extensions/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Extension](ctp:api:type:Extension).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Update Extension by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/extensions/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"my-new-extension-key\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ExtensionUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Get Extension by id","description":"Retrieves the representation of an extension by its id.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/extensions/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Delete Extension by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/extensions/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyExtensionsKeyByKey","resourcePathUri":"/{projectKey}/extensions/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Extension](ctp:api:type:Extension).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Update Extension by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/extensions/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"my-new-extension-key\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ExtensionUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Get Extension by key","description":"Retrieves the representation of an extension by its key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/extensions/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_extensions:{projectKey}"]}}],"displayName":"Delete Extension by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Extension","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/extensions/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyGraphql","resourcePathUri":"/{projectKey}/graphql","description":"The commercetools™ platform provides a GraphQL API","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"GraphQL","description":"Execute a GraphQL query","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"GraphQLResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/graphql -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"query\" : \"query query_1($productId: String){n        product(key:$productId){n          keyn        }n      }\",\n  \"operationName\" : \"query_1\",\n  \"variables\" : {\n    \"productId\" : \"f8ded810-a1\"\n  }\n}\nDATA"}],"body":{"applicationjson":null}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKey","resourcePathUri":"/{projectKey}/in-store/key={storeKey}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCarts","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/carts","description":"A shopping cart holds product variants and can be ordered.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Create cart in store","description":"Creates a cart in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nWhen using this endpoint the cart's store field is always set to the store specified in the path parameter.\nCreating a cart can fail with an InvalidOperation if the referenced shipping method\nin the CartDraft has a predicate which does not match the cart.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"currency\" : \"EUR\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Query carts in store","description":"Queries carts in a specific Store. The {storeKey} path parameter maps to a Store's key.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"customerId","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartPagedQueryResponse | object","builtinType":"any"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCartsById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/carts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Update cart by id in store","description":"Updates a cart in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the cart exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get cart by id in store","description":"Returns a cart by its ID from a specific Store. The {storeKey} path parameter maps to a Store's key.\nIf the cart exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\nThe cart may not contain up-to-date prices, discounts etc.\nIf you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Delete cart by id in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerId","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/carts/customer-id={customerId}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"customerid","type":"string","builtinType":"string","description":"`customerId` of the [Cart](ctp:api:type:Cart).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get cart by customer id in store","description":"Retrieves the active cart of the customer that has been modified most recently in a specific Store.\nThe {storeKey} path parameter maps to a Store's key.\n\nIf the cart exists in the commercetools project but does not have the store field, or the store field\nreferences a different store, this method returns a ResourceNotFound error.\n\nThe cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date,\nsend an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/customer-id={customerId} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKey","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/carts/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Update cart by key in store","description":"Updates a cart in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the cart exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get cart by key in store","description":"Returns a cart by its key from a specific Store. The {storeKey} path parameter maps to a Store's key.\nIf the cart exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\nThe cart may not contain up-to-date prices, discounts etc.\nIf you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Delete cart by key in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/carts/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCartsReplicate","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/carts/replicate","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}:{storeKey}","manage_orders:{projectKey}"]}}],"displayName":"Replicate cart for store","description":null,"queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ReplicaCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomers","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers","description":"A customer is a person purchasing products. customers, Orders,\nComments and Reviews can be associated to a customer.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Create customer in store","description":"Creates a customer in a specific Store. The {storeKey} path parameter maps to a Store's key.\nWhen using this endpoint, if omitted,\nthe customer's stores field is set to the store specified in the path parameter.\nIf an anonymous cart is passed in as when using this method,\nthen the cart is assigned to the created customer and the version number of the Cart increases.\nIf the ID of an anonymous session is given, all carts and orders will be assigned to the created customer and\nthe store specified. If you pass in a cart with a store field specified,\nthe store field must reference the same store specified in the {storeKey} path parameter.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"email\" : \"<random>@example.com\",\n  \"firstName\" : \"John\",\n  \"lastName\" : \"Doe\",\n  \"password\" : \"secret123\"\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customers:{projectKey}:{storeKey}"]}}],"displayName":"Query customers in store","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Customer](ctp:api:type:Customer).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Post customer by id in store","description":"Updates a customer in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the customer exists in the commercetools project but the stores field references a different store,\nthis method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"addAddress\",\n    \"address\" : {\n      \"streetName\" : \"Any Street\",\n      \"streetNumber\" : \"1337\",\n      \"postalCode\" : \"11111\",\n      \"city\" : \"Any City\",\n      \"country\" : \"US\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customers:{projectKey}:{storeKey}"]}}],"displayName":"Get customer by id in store","description":"Returns a customer by its ID from a specific Store. The {storeKey} path parameter maps to a Store's key.\nIt also considers customers that do not have the stores field.\nIf the customer exists in the commercetools project but the stores field references different stores,\nthis method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Delete customer by id in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirm","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/email/confirm","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Verify Customer's Email in store","description":"Verifies customer's email using a token.","queryParameters":null,"responses":[{"code":200,"description":"The email was verified.","body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerEmailVerify","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersEmailToken","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/email-token","description":"To verify a customer's email, an email token can be created. This should be embedded in a link and sent to the\ncustomer via email. When the customer clicks on the link,\nthe \"verify customer's email\" endpoint should be called,\nwhich sets customer's isVerifiedEmail field to true.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Create a Token for verifying the Customer's Email in store","description":"Create a Token for verifying the Customer's Email in store","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerToken","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerCreateEmailToken","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailToken","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/email-token={emailToken}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"emailToken","type":"string","builtinType":"string","description":"`emailToken` of the [Customer](ctp:api:type:Customer).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customers:{projectKey}:{storeKey}"]}}],"displayName":"Get customer by email verification token in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/email-token={emailToken} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKey","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Customer](ctp:api:type:Customer).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Update customer by key in store","description":"If the customer exists in the commercetools project but the stores field references a different store,\nthis method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"addAddress\",\n    \"address\" : {\n      \"streetName\" : \"Any Street\",\n      \"streetNumber\" : \"1337\",\n      \"postalCode\" : \"11111\",\n      \"city\" : \"Any City\",\n      \"country\" : \"US\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"CustomerUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customers:{projectKey}:{storeKey}"]}}],"displayName":"Get customer by key in store","description":"Returns a customer by its Key from a specific Store. The {storeKey} path parameter maps to a Store's key.\nIt also considers customers that do not have the stores field.\nIf the customer exists in the commercetools project but the stores field references different stores,\nthis method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Delete customer by key in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersPassword","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/password","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Change a customers password in store","description":"Change a customers password","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerChangePassword","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordReset","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/password/reset","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Reset Customer's Password in store","description":"Set a new password using a token.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerResetPassword","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordToken","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/password-token","description":"The following workflow can be used to reset the customer's password:\n\n* Create a password reset token and send it embedded in a link to the customer.\n* When the customer clicks on the link, the customer is retrieved with the token.\n* The customer enters a new password and the \"reset customer's password\" endpoint is called.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Create a Token for Resetting the Customer's Password in store","description":"The token value is used to reset the password of the customer with the given email. The token is\nvalid only for 10 minutes.","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerToken","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerCreatePasswordResetToken","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordToken","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/customers/password-token={passwordToken}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"passwordToken","type":"string","builtinType":"string","description":"`passwordToken` of the [Customer](ctp:api:type:Customer).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_customers:{projectKey}","view_customers:{projectKey}:{storeKey}"]}}],"displayName":"Get customer by password verification token in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/customers/password-token={passwordToken} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyLogin","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/login","description":"Retrieves the authenticated customer.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}","manage_customers:{projectKey}:{storeKey}"]}}],"displayName":"Authenticate Customer (Sign In) in store","description":"Authenticate Customer (Sign In) in store","queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerSignin","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMe","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeActiveCart","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/active-cart","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get my active cart in store","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/active-cart -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeCarts","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/carts","description":"A shopping cart holds product variants and can be ordered.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Create my cart in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"currency\" : \"EUR\"\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Query my carts in store","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeCartsById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/carts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Update my cart by id in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get my cart by id in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Delete my cart by id in store","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/carts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeOrders","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/orders","description":"An order can be created from a order, usually after a checkout process has been completed.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Create my order in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"id\" : \"7c2e2694-aefe-43d7-888e-6a99514caaca\",\n  \"version\" : 10,\n  \"orderNumber\" : \"201612010001\"\n}\nDATA"}],"body":{"applicationjson":{"type":"MyOrderFromCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Query my orders in store","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeOrdersById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/orders/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Order](ctp:api:type:Order).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}","manage_my_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get my order by id in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeShoppingLists","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/shopping-lists","description":"shopping-lists e.g. for wishlist support","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Create my shopping lists in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"test\"\n  },\n  \"key\" : \"test\"\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get my shopping lists in store","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingListPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/shopping-lists/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Update my shopping list by id in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get my shopping list by id in store","description":"Gets a shopping list by ID.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Delete my shopping list by id in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKey","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/me/shopping-lists/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Update my shopping list by key in store","description":"Update a shopping list found by its Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get my shopping list by key in store","description":"Gets a shopping list by Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Delete my shopping list by key in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/me/shopping-lists/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyShippingMethods","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/shipping-methods","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCart","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/shipping-methods/matching-cart","description":"Get ShippingMethods for a cart in a store","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","manage_customers:{projectKey}:{storeKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethods for a cart in a store","description":null,"queryParameters":[{"name":"cartId","required":true,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethodPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shipping-methods/matching-cart?cartId={cartId} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyShoppingLists","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/shopping-lists","description":"shopping-lists e.g. for wishlist support","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Create shopping lists in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"test\"\n  },\n  \"key\" : \"test\"\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get shopping lists in store","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingListPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyShoppingListsById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/shopping-lists/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Update shopping list by id in store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get shopping list by id in store","description":"Gets a shopping list by ID.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Delete shopping list by id in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKey","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/shopping-lists/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Update shopping list by key in store","description":"Update a shopping list found by its Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}","view_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Get shopping list by key in store","description":"Gets a shopping list by Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}","manage_shopping_lists:{projectKey}:{storeKey}"]}}],"displayName":"Delete shopping list by key in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/shopping-lists/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInventory","resourcePathUri":"/{projectKey}/inventory","description":"Inventory allows you to track stock quantities.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create InventoryEntry","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"InventoryEntry","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/inventory -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"sku\" : \"sku_GIRLS_HARTBREAK_CREW_variant1_1421832124541\",\n  \"quantityOnStock\" : 4,\n  \"availableQuantity\" : 4\n}\nDATA"}],"body":{"applicationjson":{"type":"InventoryEntryDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query inventory","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"InventoryPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/inventory -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInventoryById","resourcePathUri":"/{projectKey}/inventory/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [InventoryEntry](ctp:api:type:InventoryEntry).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update InventoryEntry by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"InventoryEntry","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/inventory/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addQuantity\",\n    \"quantity\" : 4\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"InventoryEntryUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get InventoryEntry by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"InventoryEntry","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/inventory/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete InventoryEntry by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"InventoryEntry","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/inventory/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyLogin","resourcePathUri":"/{projectKey}/login","description":"Retrieves the authenticated customer.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_customers:{projectKey}"]}}],"displayName":"Authenticate Customer (Sign In)","description":"Authenticate Customer (Sign In). Retrieves the authenticated\ncustomer (a customer that matches the given email/password pair).\nIf used with an access token for Anonymous Sessions,\nall orders and carts belonging to the anonymousId will be assigned to the newly created customer.\nIf a cart is is returned as part of the CustomerSignInResult,\nit has been recalculated (It will have up-to-date prices, taxes and discounts,\nand invalid line items have been removed.).","queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerSignin","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMe","resourcePathUri":"/{projectKey}/me","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Update my customer","description":"Update my customer","queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"addAddress\",\n    \"address\" : {\n      \"streetName\" : \"Any Street\",\n      \"streetNumber\" : \"1337\",\n      \"postalCode\" : \"11111\",\n      \"city\" : \"Any City\",\n      \"country\" : \"US\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCustomerUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Get my customer details","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Delete my Customer","description":"Delete my Customer","queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeActiveCart","resourcePathUri":"/{projectKey}/me/active-cart","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Get my active cart","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/active-cart -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeCarts","resourcePathUri":"/{projectKey}/me/carts","description":"A shopping cart holds product variants and can be ordered.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Create my cart","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"currency\" : \"EUR\"\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Query my carts","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CartPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/carts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeCartsById","resourcePathUri":"/{projectKey}/me/carts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Update my cart by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Get my cart by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/carts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Delete my cart by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/carts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeCartsKeyByKey","resourcePathUri":"/{projectKey}/me/carts/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Cart](ctp:api:type:Cart).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Update my cart by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"addLineItem\",\n    \"productId\" : \"9f10dcfb-5cc9-4a18-843a-c07f7e22d01f\",\n    \"variantId\" : 1,\n    \"quantity\" : 1\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyCartUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Get my cart by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/carts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Delete my cart by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Cart","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/carts/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeEmailConfirm","resourcePathUri":"/{projectKey}/me/email/confirm","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Verify my Customer's Email","description":null,"queryParameters":null,"responses":null,"codeExamples":null,"body":null},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeLogin","resourcePathUri":"/{projectKey}/me/login","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Authenticate my Customer (Sign In)","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"CustomerSignin","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeOrders","resourcePathUri":"/{projectKey}/me/orders","description":"An order can be created from a cart, usually after a checkout process has been completed.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Create my order","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"id\" : \"7c2e2694-aefe-43d7-888e-6a99514caaca\",\n  \"version\" : 10,\n  \"orderNumber\" : \"201612010001\"\n}\nDATA"}],"body":{"applicationjson":{"type":"MyOrderFromCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Query my orders","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeOrdersById","resourcePathUri":"/{projectKey}/me/orders/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Order](ctp:api:type:Order).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_orders:{projectKey}"]}}],"displayName":"Get my order by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMePassword","resourcePathUri":"/{projectKey}/me/password","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Change my customers password","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"MyCustomerChangePassword","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMePasswordReset","resourcePathUri":"/{projectKey}/me/password/reset","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Reset my Customer's Password","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Customer","builtinType":"object"}}}],"codeExamples":null,"body":null},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMePayments","resourcePathUri":"/{projectKey}/me/payments","description":"The My Payments endpoint creates and provides access to payments scoped to a specific user.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Create my payment","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/payments -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"amountPlanned\" : {\n    \"currencyCode\" : \"USD\",\n    \"centAmount\" : 1000\n  },\n  \"paymentMethodInfo\" : {\n    \"paymentInterface\" : \"STRIPE\",\n    \"method\" : \"CREDIT_CARD\",\n    \"name\" : {\n      \"en\" : \"Credit Card\"\n    }\n  },\n  \"transaction\" : {\n    \"timestamp\" : \"2015-10-20T08:54:24.000Z\",\n    \"type\" : \"Charge\",\n    \"amount\" : {\n      \"currencyCode\" : \"USD\",\n      \"centAmount\" : 1000\n    }\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"MyPaymentDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Query my payments","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPaymentPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/payments -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMePaymentsById","resourcePathUri":"/{projectKey}/me/payments/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [MyPayment](ctp:api:type:MyPayment).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Update my payment by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/payments/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setMethodInfoMethod\",\n    \"method\" : \"12334567890123456\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyPaymentUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Get my payment by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/payments/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Delete my payment by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/payments/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMePaymentsKeyByKey","resourcePathUri":"/{projectKey}/me/payments/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [MyPayment](ctp:api:type:MyPayment).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Update my payment by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/payments/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setMethodInfoMethod\",\n    \"method\" : \"12334567890123456\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyPaymentUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Get my payment by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/payments/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_payments:{projectKey}"]}}],"displayName":"Delete my payment by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MyPayment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/payments/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeShoppingListsById","resourcePathUri":"/{projectKey}/me/shopping-lists/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Update my shopping list by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Get my shopping list by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Delete my shopping list by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeShoppingLists","resourcePathUri":"/{projectKey}/me/shopping-lists","description":"The My Shopping Lists endpoint creates and provides access to shopping lists scoped to a specific user.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Create my shopping list","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"test\"\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Query my shopping lists","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingListPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMeShoppingListsKeyByKey","resourcePathUri":"/{projectKey}/me/shopping-lists/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Update my shopping list by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"MyShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Get my shopping list by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_shopping_lists:{projectKey}"]}}],"displayName":"Delete my shopping list by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/me/shopping-lists/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyMeSignup","resourcePathUri":"/{projectKey}/me/signup","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_my_profile:{projectKey}"]}}],"displayName":"Signup my customer","description":null,"queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"CustomerSignInResult","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"MyCustomerDraft","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMessages","resourcePathUri":"/{projectKey}/messages","description":"A message represents a change or an action performed on a resource (like an Order or a Product).","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_messages:{projectKey}"]}}],"displayName":"Query messages","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"MessagePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/messages -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyMessagesById","resourcePathUri":"/{projectKey}/messages/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Message](ctp:api:type:Message).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_messages:{projectKey}"]}}],"displayName":"Get Message by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Message","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/messages/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyOrders","resourcePathUri":"/{projectKey}/orders","description":"An order can be created from a order, usually after a checkout process has been completed.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Create Order","description":"Creates an order from a Cart.\nThe cart must have a shipping address set before creating an order.\nWhen using the Platform TaxMode, the shipping address is used for tax calculation.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"id\" : \"7c2e2694-aefe-43d7-888e-6a99514caaca\",\n  \"version\" : 10,\n  \"orderNumber\" : \"201612010001\"\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderFromCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Query orders","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyOrdersById","resourcePathUri":"/{projectKey}/orders/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Order](ctp:api:type:Order).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Order by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeOrderState\",\n    \"orderState\" : \"Complete\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Order by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Order by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyOrdersEdits","resourcePathUri":"/{projectKey}/orders/edits","description":"OrderEdit are containers for financial changes after an Order has been placed.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Create OrderEdit","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/edits -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"order-edit-key\",\n  \"resource\" : {\n    \"typeId\" : \"order\",\n    \"id\" : \"ed454f4e-c43a-485f-a86f-046c691b1363\"\n  },\n  \"stagedActions\" : [ {\n    \"action\" : \"setCustomerEmail\",\n    \"email\" : \"user@localhost\"\n  } ],\n  \"comment\" : \"sample-comment\"\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderEditDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_order_edits:{projectKey}"]}}],"displayName":"Query edits","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEditPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders/edits -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyOrdersEditsById","resourcePathUri":"/{projectKey}/orders/edits/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [OrderEdit](ctp:api:type:OrderEdit).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Update OrderEdit by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/edits/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 7,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"another-key\"\n  }, {\n    \"action\" : \"addStagedAction\",\n    \"stagedAction\" : {\n      \"action\" : \"setCountry\",\n      \"country\" : \"ES\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderEditUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_order_edits:{projectKey}"]}}],"displayName":"Get OrderEdit by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders/edits/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Delete OrderEdit by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/edits/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyOrdersEditsByIdApply","resourcePathUri":"/{projectKey}/orders/edits/{id}/apply","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [OrderEdit](ctp:api:type:OrderEdit).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Apply order edit","description":null,"queryParameters":null,"responses":null,"codeExamples":null,"body":{"applicationjson":{"type":"OrderEditApply","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyOrdersEditsKeyByKey","resourcePathUri":"/{projectKey}/orders/edits/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [OrderEdit](ctp:api:type:OrderEdit).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Update OrderEdit by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/edits/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 7,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"another-key\"\n  }, {\n    \"action\" : \"addStagedAction\",\n    \"stagedAction\" : {\n      \"action\" : \"setCountry\",\n      \"country\" : \"ES\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderEditUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_order_edits:{projectKey}"]}}],"displayName":"Get OrderEdit by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders/edits/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_order_edits:{projectKey}"]}}],"displayName":"Delete OrderEdit by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderEdit","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/edits/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyOrdersImport","resourcePathUri":"/{projectKey}/orders/import","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Create an Order by Import","description":"Create an Order by Import","queryParameters":null,"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/import -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"orderNumber\" : \"100000001\",\n  \"totalPrice\" : {\n    \"centAmount\" : 1000,\n    \"currencyCode\" : \"EUR\"\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderImportDraft","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyOrdersOrderNumberByOrderNumber","resourcePathUri":"/{projectKey}/orders/order-number={orderNumber}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"orderNumber","type":"string","builtinType":"string","description":"`orderNumber` of the [Order](ctp:api:type:Order).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Order by orderNumber","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeOrderState\",\n    \"orderState\" : \"Complete\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Order by orderNumber","description":"In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+,\nit should be provided in URL-encoded format.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Order by orderNumber","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyPayments","resourcePathUri":"/{projectKey}/payments","description":"Payments hold information about the current state of receiving and/or refunding money","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_payments:{projectKey}"]}}],"displayName":"Create Payment","description":"To create a payment object a payment draft object has to be given with the request.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/payments -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"123456\",\n  \"interfaceId\" : \"789011\",\n  \"amountPlanned\" : {\n    \"currencyCode\" : \"USD\",\n    \"centAmount\" : 1000\n  },\n  \"paymentMethodInfo\" : {\n    \"paymentInterface\" : \"STRIPE\",\n    \"method\" : \"CREDIT_CARD\",\n    \"name\" : {\n      \"en\" : \"Credit Card\"\n    }\n  },\n  \"transactions\" : [ {\n    \"timestamp\" : \"2015-10-20T08:54:24.000Z\",\n    \"type\" : \"Charge\",\n    \"amount\" : {\n      \"currencyCode\" : \"USD\",\n      \"centAmount\" : 1000\n    },\n    \"state\" : \"Pending\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"PaymentDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_payments:{projectKey}"]}}],"displayName":"Query payments","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"PaymentPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/payments -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyPaymentsById","resourcePathUri":"/{projectKey}/payments/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Payment](ctp:api:type:Payment).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_payments:{projectKey}"]}}],"displayName":"Update Payment by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/payments/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setInterfaceId\",\n    \"interfaceId\" : \"12334567890123456\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"PaymentUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_payments:{projectKey}"]}}],"displayName":"Get Payment by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/payments/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_payments:{projectKey}"]}}],"displayName":"Delete Payment by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payments/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyPaymentsKeyByKey","resourcePathUri":"/{projectKey}/payments/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Payment](ctp:api:type:Payment).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_payments:{projectKey}"]}}],"displayName":"Update Payment by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/payments/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setInterfaceId\",\n    \"interfaceId\" : \"12334567890123456\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"PaymentUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_payments:{projectKey}"]}}],"displayName":"Get Payment by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/payments/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_payments:{projectKey}"]}}],"displayName":"Delete Payment by key","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Payment","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payments/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProductDiscounts","resourcePathUri":"/{projectKey}/product-discounts","description":"Product discounts are used to change certain product prices.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create ProductDiscount","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-discounts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"value\" : {\n    \"type\" : \"absolute\",\n    \"money\" : [ {\n      \"currencyCode\" : \"EUR\",\n      \"centAmount\" : 100\n    } ]\n  },\n  \"predicate\" : \"1=1\",\n  \"name\" : {\n    \"en\" : \"test-discount1\"\n  },\n  \"description\" : {\n    \"en\" : \"test-discount1\"\n  },\n  \"isActive\" : false,\n  \"sortOrder\" : \"0.9534\"\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductDiscountDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query product-discounts","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscountPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-discounts -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductDiscountsById","resourcePathUri":"/{projectKey}/product-discounts/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ProductDiscount](ctp:api:type:ProductDiscount).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update ProductDiscount by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-discounts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeValue\",\n    \"value\" : {\n      \"type\" : \"absolute\",\n      \"money\" : [ {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 100\n      } ]\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductDiscountUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get ProductDiscount by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-discounts/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete ProductDiscount by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/product-discounts/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProductDiscountsKeyByKey","resourcePathUri":"/{projectKey}/product-discounts/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ProductDiscount](ctp:api:type:ProductDiscount).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update ProductDiscount by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-discounts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeValue\",\n    \"value\" : {\n      \"type\" : \"absolute\",\n      \"money\" : [ {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 100\n      } ]\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductDiscountUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get ProductDiscount by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-discounts/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete ProductDiscount by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/product-discounts/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProductDiscountsMatching","resourcePathUri":"/{projectKey}/product-discounts/matching","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get matching product discounts","description":null,"queryParameters":null,"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductDiscount","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-discounts/matching -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n\"{n  \"productId\": \"123456\",n  \"variantId\": 1,n  \"staged\": false,n  \"price\": {n    \"value\": {n      \"type\": \"centPrecision\",n      \"centAmount\": 100,n      \"currencyCode\": \"EUR\",n      \"fractionDigits\": 2n    },n  \"id\": \"2474c2c3-d424-49af-b90a-b71bc74cf51b\"n  }n}n\"\nDATA"}],"body":{"applicationjson":{"type":"ProductDiscountMatchQuery","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductProjections","resourcePathUri":"/{projectKey}/product-projections","description":"A projected representation of a product shows the product with its current or staged data. The current or staged\nrepresentation of a product in a catalog is called a product projection.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Query product-projections","description":"You can use the product projections query endpoint to get the current or staged representations of Products.\nWhen used with an API client that has the view_published_products:{projectKey} scope,\nthis endpoint only returns published (current) product projections.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductProjectionPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-projections -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductProjectionsById","resourcePathUri":"/{projectKey}/product-projections/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ProductProjection](ctp:api:type:ProductProjection).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Get ProductProjection by id","description":"Gets the current or staged representation of a product in a catalog by ID.\nWhen used with an API client that has the view_published_products:{projectKey} scope,\nthis endpoint only returns published (current) product projections.","queryParameters":[{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductProjection","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-projections/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductProjectionsKeyByKey","resourcePathUri":"/{projectKey}/product-projections/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ProductProjection](ctp:api:type:ProductProjection).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Get ProductProjection by key","description":"Gets the current or staged representation of a product found by Key.\nWhen used with an API client that has the view_published_products:{projectKey} scope,\nthis endpoint only returns published (current) product projections.","queryParameters":[{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductProjection","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-projections/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductProjectionsSearch","resourcePathUri":"/{projectKey}/product-projections/search","description":"This endpoint provides high performance search queries over ProductProjections. The query result contains the\nProductProjections for which at least one ProductVariant matches the search query. This means that variants can\nbe included in the result also for which the search query does not match. To determine which ProductVariants match\nthe search query, the returned ProductProjections include the additional field isMatchingVariant.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Search Products by post","description":"Search Product Projection","queryParameters":null,"responses":null,"codeExamples":null,"body":{"applicationjson":null}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Search Products by get","description":"Search Product Projection","queryParameters":[{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"fuzzy","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to apply fuzzy search on the text to analyze.","items":null},{"name":"fuzzyLevel","required":false,"type":"Float","builtinType":"Float","description":"Provide explicitly the fuzzy level desired if fuzzy is enabled. This value can not be higher than the one\nchosen by the platform by default.","items":null},{"name":"markMatchingVariants","required":true,"type":"boolean","builtinType":"boolean","description":"if `markMatchingVariants` parameter is `true` those ProductVariants that match the search query have the additional\nfield `isMatchingVariant` set to `true`. For the other variants in the same product projection this field is set to `false`.","items":null},{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"filter","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"filter.facets","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"filter.query","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"facet","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"/text.[a-z]{2}(-[A-Z]{2})?/","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductProjectionPagedSearchResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-projections/search?markMatchingVariants={markMatchingVariants} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductProjectionsSuggest","resourcePathUri":"/{projectKey}/product-projections/suggest","description":"The source of data for suggestions is the searchKeyword field in a product","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_published_products:{projectKey}"]}}],"displayName":"Get suggestion keywords","description":null,"queryParameters":[{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"fuzzy","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to apply fuzzy search on the text to analyze.","items":null},{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"/searchKeywords.[a-z]{2}(-[A-Z]{2})?/","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"any","builtinType":"any"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-projections/suggest -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductTypes","resourcePathUri":"/{projectKey}/product-types","description":"Product Types are used to describe common characteristics, most importantly common custom attributes,\nof many concrete products.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create ProductType","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-types -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : \"test_product_type\",\n  \"description\" : \"Test product type.\",\n  \"attributes\" : [ {\n    \"type\" : {\n      \"name\" : \"text\"\n    },\n    \"isSearchable\" : false,\n    \"inputHint\" : \"SingleLine\",\n    \"name\" : \"size\",\n    \"label\" : {\n      \"en\" : \"The right size is important.\"\n    },\n    \"isRequired\" : false,\n    \"attributeConstraint\" : \"CombinationUnique\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductTypeDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query product-types","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductTypePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-types -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductTypesById","resourcePathUri":"/{projectKey}/product-types/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ProductType](ctp:api:type:ProductType).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update ProductType by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-types/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"new-product-type-name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductTypeUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get ProductType by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-types/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete ProductType by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/product-types/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProductTypesKeyByKey","resourcePathUri":"/{projectKey}/product-types/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ProductType](ctp:api:type:ProductType).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update ProductType by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/product-types/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 3,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"new-product-type-name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductTypeUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get ProductType by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/product-types/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete ProductType by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/product-types/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProducts","resourcePathUri":"/{projectKey}/products","description":"Products are the sellable goods in an e-commerce project on CTP. This document explains some design concepts\nof products on CTP and describes the available HTTP APIs for working with them.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create Product","description":"To create a new product, send a representation that is going to become the initial staged representation\nof the new product in the master catalog. If price selection query parameters are provided,\nthe selected prices will be added to the response.","queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/products -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"productType\" : {\n    \"id\" : \"24f510c3-f334-4099-94e2-d6224a8eb919\",\n    \"typeId\" : \"product-type\"\n  },\n  \"categories\" : [ {\n    \"typeId\" : \"category\",\n    \"id\" : \"24f510c3-f334-4099-94e2-d6224a8eb919\"\n  } ],\n  \"name\" : {\n    \"en\" : \"Some Product\"\n  },\n  \"slug\" : {\n    \"en\" : \"product_slug_<random-uuid>\"\n  },\n  \"masterVariant\" : {\n    \"sku\" : \"SKU-1\",\n    \"prices\" : [ {\n      \"value\" : {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 4200\n      }\n    } ],\n    \"images\" : [ {\n      \"url\" : \"http://my.custom.cdn.net/master.png\",\n      \"label\" : \"Master Image\",\n      \"dimensions\" : {\n        \"w\" : 303,\n        \"h\" : 197\n      }\n    } ]\n  },\n  \"variants\" : [ {\n    \"images\" : [ {\n      \"url\" : \"http://my.custom.cdn.net/variant.png\",\n      \"label\" : \"Variant Image\",\n      \"dimensions\" : {\n        \"w\" : 303,\n        \"h\" : 197\n      }\n    } ]\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query products","description":"You can use the query endpoint to get the full representations of products.\nREMARK: We suggest to use the performance optimized search endpoint which has a bunch functionalities,\nthe query API lacks like sorting on custom attributes, etc.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ProductPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/products -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductsById","resourcePathUri":"/{projectKey}/products/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Product](ctp:api:type:Product).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update Product by id","description":null,"queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/products/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 2,\n  \"actions\" : [ {\n    \"action\" : \"setDescription\",\n    \"description\" : {\n      \"en\" : \"The best product ever!\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get Product by id","description":"Gets the full representation of a product by ID.","queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/products/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete Product by id","description":null,"queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/products/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyProductsByIdImages","resourcePathUri":"/{projectKey}/products/{id}/images","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Product](ctp:api:type:Product).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Upload a product image","description":"Uploads a binary image file to a given product variant. The supported image formats are JPEG, PNG and GIF.","queryParameters":[{"name":"filename","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"variant","required":false,"type":"Int","builtinType":"Int","description":null,"items":null},{"name":"sku","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"file","builtinType":"file"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyProductsKeyByKey","resourcePathUri":"/{projectKey}/products/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Product](ctp:api:type:Product).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update Product by key","description":null,"queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/products/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 2,\n  \"actions\" : [ {\n    \"action\" : \"setDescription\",\n    \"description\" : {\n      \"en\" : \"The best product ever!\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ProductUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get Product by key","description":"Gets the full representation of a product by Key.","queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/products/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete Product by key","description":null,"queryParameters":[{"name":"priceCurrency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCountry","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceCustomerGroup","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"priceChannel","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"localeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"storeProjection","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Product","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/products/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyReviews","resourcePathUri":"/{projectKey}/reviews","description":"Reviews are used to evaluate products and channels.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Create Review","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/reviews -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"authorName\" : \"John Doe\",\n  \"title\" : \"Incredible\",\n  \"text\" : \"Best product ever\",\n  \"rating\" : 5,\n  \"target\" : {\n    \"typeId\" : \"product\",\n    \"id\" : \"8fddacac-6ef5-4e66-af6e-124452123456\"\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"ReviewDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Query reviews","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ReviewPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/reviews -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyReviewsById","resourcePathUri":"/{projectKey}/reviews/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Review](ctp:api:type:Review).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update Review by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/reviews/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setAuthorName\",\n    \"authorName\" : \"John Doe\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ReviewUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get Review by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/reviews/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete Review by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/reviews/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyReviewsKeyByKey","resourcePathUri":"/{projectKey}/reviews/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Review](ctp:api:type:Review).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Update Review by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/reviews/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setAuthorName\",\n    \"authorName\" : \"John Doe\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ReviewUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}"]}}],"displayName":"Get Review by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/reviews/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}"]}}],"displayName":"Delete Review by key","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Review","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/reviews/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethods","resourcePathUri":"/{projectKey}/shipping-methods","description":"Shipping Methods define where orders can be shipped and what the costs are.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_shipping_methods:{projectKey}"]}}],"displayName":"Create ShippingMethod","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shipping-methods -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : \"DHL\",\n  \"description\" : \"Standard delivery\",\n  \"taxCategory\" : {\n    \"typeId\" : \"tax-category\",\n    \"id\" : \"5a21f15b-34f8-4b7f-9407-d1eb82a73eba\"\n  },\n  \"zoneRates\" : [ {\n    \"zone\" : {\n      \"typeId\" : \"zone\",\n      \"id\" : \"5cb532be-c680-43ab-ba14-b664bb03dc35\"\n    },\n    \"shippingRates\" : [ {\n      \"price\" : {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 570\n      }\n    } ]\n  }, {\n    \"zone\" : {\n      \"typeId\" : \"zone\",\n      \"id\" : \"ebe01381-82be-4e63-9993-d1eb8f8e588b\"\n    },\n    \"shippingRates\" : [ {\n      \"price\" : {\n        \"currencyCode\" : \"USD\",\n        \"centAmount\" : 990\n      }\n    } ]\n  } ],\n  \"isDefault\" : false\n}\nDATA"}],"body":{"applicationjson":{"type":"ShippingMethodDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Query shipping-methods","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethodPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethodsById","resourcePathUri":"/{projectKey}/shipping-methods/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ShippingMethod](ctp:api:type:ShippingMethod).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_shipping_methods:{projectKey}"]}}],"displayName":"Update ShippingMethod by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shipping-methods/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShippingMethodUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethod by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_shipping_methods:{projectKey}"]}}],"displayName":"Delete ShippingMethod by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/shipping-methods/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethodsKeyByKey","resourcePathUri":"/{projectKey}/shipping-methods/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ShippingMethod](ctp:api:type:ShippingMethod).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_shipping_methods:{projectKey}"]}}],"displayName":"Update ShippingMethod by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shipping-methods/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShippingMethodUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethod by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_shipping_methods:{projectKey}"]}}],"displayName":"Delete ShippingMethod by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethod","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/shipping-methods/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethodsMatchingCart","resourcePathUri":"/{projectKey}/shipping-methods/matching-cart","description":"Get ShippingMethods for a cart","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethods for a cart","description":null,"queryParameters":[{"name":"cartId","required":true,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethodPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods/matching-cart?cartId={cartId} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethodsMatchingLocation","resourcePathUri":"/{projectKey}/shipping-methods/matching-location","description":"Get ShippingMethods for a location","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethods for a location","description":null,"queryParameters":[{"name":"country","required":true,"type":"string","builtinType":"string","description":null,"items":null},{"name":"state","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"currency","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethodPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods/matching-location?country={country} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyShippingMethodsMatchingOrderedit","resourcePathUri":"/{projectKey}/shipping-methods/matching-orderedit","description":"Get ShippingMethods for an order edit","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_shipping_methods:{projectKey}"]}}],"displayName":"Get ShippingMethods for an order edit","description":null,"queryParameters":[{"name":"orderEditId","required":true,"type":"string","builtinType":"string","description":null,"items":null},{"name":"country","required":true,"type":"string","builtinType":"string","description":null,"items":null},{"name":"state","required":false,"type":"string","builtinType":"string","description":null,"items":null}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShippingMethodPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shipping-methods/matching-orderedit?orderEditId={orderEditId}&country={country} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyShoppingLists","resourcePathUri":"/{projectKey}/shopping-lists","description":"shopping-lists e.g. for wishlist support","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}"]}}],"displayName":"Create ShoppingList","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : {\n    \"en\" : \"test\"\n  },\n  \"key\" : \"test\"\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}"]}}],"displayName":"Query shopping-lists","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingListPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shopping-lists -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyShoppingListsById","resourcePathUri":"/{projectKey}/shopping-lists/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}"]}}],"displayName":"Update ShoppingList by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}"]}}],"displayName":"Get ShoppingList by id","description":"Gets a shopping list by ID.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shopping-lists/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}"]}}],"displayName":"Delete ShoppingList by id","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/shopping-lists/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyShoppingListsKeyByKey","resourcePathUri":"/{projectKey}/shopping-lists/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [ShoppingList](ctp:api:type:ShoppingList).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}"]}}],"displayName":"Update ShoppingList by key","description":"Update a shopping list found by its Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ShoppingListUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_shopping_lists:{projectKey}"]}}],"displayName":"Get ShoppingList by key","description":"Gets a shopping list by Key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/shopping-lists/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_shopping_lists:{projectKey}"]}}],"displayName":"Delete ShoppingList by key","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ShoppingList","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/shopping-lists/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyStates","resourcePathUri":"/{projectKey}/states","description":"The commercetools platform allows you to model states of certain objects, such as orders, line items, products,\nreviews, and payments in order to define finite state machines reflecting the business logic you'd like to\nimplement.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_states:{projectKey}"]}}],"displayName":"Create State","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/states -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"test-state\",\n  \"type\" : \"ProductState\",\n  \"roles\" : [ ],\n  \"initial\" : true\n}\nDATA"}],"body":{"applicationjson":{"type":"StateDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_states:{projectKey}"]}}],"displayName":"Query states","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"StatePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/states -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyStatesById","resourcePathUri":"/{projectKey}/states/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [State](ctp:api:type:State).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_states:{projectKey}"]}}],"displayName":"Update State by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/states/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"StateUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_states:{projectKey}"]}}],"displayName":"Get State by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/states/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_states:{projectKey}"]}}],"displayName":"Delete State by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/states/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyStatesKeyByKey","resourcePathUri":"/{projectKey}/states/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [State](ctp:api:type:State).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_states:{projectKey}"]}}],"displayName":"Update State by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/states/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"StateUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_states:{projectKey}"]}}],"displayName":"Get State by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/states/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_states:{projectKey}"]}}],"displayName":"Delete State by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"State","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/states/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyStores","resourcePathUri":"/{projectKey}/stores","description":"Stores let you model the context your customers shop in.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_stores:{projectKey}"]}}],"displayName":"Create Store","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/stores -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"random-key-123\",\n  \"name\" : {\n    \"en\" : \"main store\"\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"StoreDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_stores:{projectKey}"]}}],"displayName":"Query stores","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"StorePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/stores -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyStoresById","resourcePathUri":"/{projectKey}/stores/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Store](ctp:api:type:Store).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_stores:{projectKey}"]}}],"displayName":"Update Store by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/stores/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"StoreUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_stores:{projectKey}"]}}],"displayName":"Get Store by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/stores/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_stores:{projectKey}"]}}],"displayName":"Delete Store by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/stores/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyStoresKeyByKey","resourcePathUri":"/{projectKey}/stores/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Store](ctp:api:type:Store).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_stores:{projectKey}"]}}],"displayName":"Update Store by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/stores/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"StoreUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_stores:{projectKey}"]}}],"displayName":"Get Store by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/stores/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_stores:{projectKey}"]}}],"displayName":"Delete Store by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Store","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/stores/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeySubscriptions","resourcePathUri":"/{projectKey}/subscriptions","description":"Subscriptions allow you to be notified of new messages or changes via a Message Queue of your choice","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Create Subscription","description":"The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active.\nIn order to test that the destination is correctly configured, a test message will be put into the queue.\nIf the message could not be delivered, the subscription will not be created.\nThe payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription.\nCurrently, a maximum of 25 subscriptions can be created per project.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/subscriptions -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"destination\" : {\n    \"type\" : \"IronMQ\",\n    \"uri\" : \"https://queue-uri\"\n  },\n  \"messages\" : [ {\n    \"resourceTypeId\" : \"product\",\n    \"types\" : [ ]\n  } ],\n  \"key\" : \"test-queue\"\n}\nDATA"}],"body":{"applicationjson":{"type":"SubscriptionDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Query subscriptions","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"SubscriptionPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/subscriptions -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeySubscriptionsById","resourcePathUri":"/{projectKey}/subscriptions/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Subscription](ctp:api:type:Subscription).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Update Subscription by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/subscriptions/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"queue-key\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"SubscriptionUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Get Subscription by id","description":"Retrieves the representation of a subscription by its id.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/subscriptions/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Delete Subscription by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/subscriptions/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeySubscriptionsKeyByKey","resourcePathUri":"/{projectKey}/subscriptions/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Subscription](ctp:api:type:Subscription).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Update Subscription by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/subscriptions/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"queue-key\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"SubscriptionUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Get Subscription by key","description":"Retrieves the representation of a subscription by its key.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/subscriptions/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_subscriptions:{projectKey}"]}}],"displayName":"Delete Subscription by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Subscription","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/subscriptions/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyTaxCategories","resourcePathUri":"/{projectKey}/tax-categories","description":"Tax Categories define how products are to be taxed in different countries.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_tax_categories:{projectKey}"]}}],"displayName":"Create TaxCategory","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/tax-categories -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : \"test-tax-category\",\n  \"rates\" : [ {\n    \"name\" : \"test-tax-category\",\n    \"amount\" : 0.2,\n    \"includedInPrice\" : true,\n    \"country\" : \"DE\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TaxCategoryDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_tax_categories:{projectKey}"]}}],"displayName":"Query tax-categories","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategoryPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/tax-categories -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyTaxCategoriesById","resourcePathUri":"/{projectKey}/tax-categories/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [TaxCategory](ctp:api:type:TaxCategory).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_tax_categories:{projectKey}"]}}],"displayName":"Update TaxCategory by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/tax-categories/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TaxCategoryUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_tax_categories:{projectKey}"]}}],"displayName":"Get TaxCategory by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/tax-categories/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_tax_categories:{projectKey}"]}}],"displayName":"Delete TaxCategory by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/tax-categories/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyTaxCategoriesKeyByKey","resourcePathUri":"/{projectKey}/tax-categories/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [TaxCategory](ctp:api:type:TaxCategory).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_tax_categories:{projectKey}"]}}],"displayName":"Update TaxCategory by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/tax-categories/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TaxCategoryUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_products:{projectKey}","view_tax_categories:{projectKey}"]}}],"displayName":"Get TaxCategory by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/tax-categories/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_products:{projectKey}","manage_tax_categories:{projectKey}"]}}],"displayName":"Delete TaxCategory by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TaxCategory","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/tax-categories/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyTypes","resourcePathUri":"/{projectKey}/types","description":"Types define custom fields that are used to enhance resources as you need.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_types:{projectKey}"]}}],"displayName":"Create Type","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/types -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"key\" : \"lineitemtype\",\n  \"name\" : {\n    \"en\" : \"lineitem\"\n  },\n  \"description\" : {\n    \"en\" : \"description\"\n  },\n  \"resourceTypeIds\" : [ \"line-item\" ],\n  \"fieldDefinitions\" : [ {\n    \"name\" : \"offer_name\",\n    \"label\" : {\n      \"en\" : \"offer_name\"\n    },\n    \"required\" : false,\n    \"type\" : {\n      \"name\" : \"String\"\n    },\n    \"inputHint\" : \"SingleLine\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TypeDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_types:{projectKey}"]}}],"displayName":"Query types","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"TypePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/types -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyTypesById","resourcePathUri":"/{projectKey}/types/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Type](ctp:api:type:Type).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_types:{projectKey}"]}}],"displayName":"Update Type by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/types/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TypeUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_types:{projectKey}"]}}],"displayName":"Get Type by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/types/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_types:{projectKey}"]}}],"displayName":"Delete Type by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/types/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyTypesKeyByKey","resourcePathUri":"/{projectKey}/types/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Type](ctp:api:type:Type).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_types:{projectKey}"]}}],"displayName":"Update Type by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/types/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : {\n      \"en\" : \"New Name\"\n    }\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"TypeUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_types:{projectKey}"]}}],"displayName":"Get Type by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/types/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_types:{projectKey}"]}}],"displayName":"Delete Type by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Type","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/types/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyZones","resourcePathUri":"/{projectKey}/zones","description":"Zones allow defining ShippingRates for specific Locations.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Create Zone","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/zones -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"name\" : \"US\",\n  \"locations\" : [ {\n    \"country\" : \"US\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ZoneDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Query zones","description":null,"queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ZonePagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/zones -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyZonesById","resourcePathUri":"/{projectKey}/zones/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Zone](ctp:api:type:Zone).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Zone by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/zones/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ZoneUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Zone by id","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/zones/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Zone by id","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/zones/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyZonesKeyByKey","resourcePathUri":"/{projectKey}/zones/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"key","type":"string","builtinType":"string","description":"`key` of the [Zone](ctp:api:type:Zone).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Update Zone by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/zones/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeName\",\n    \"name\" : \"New Name\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ZoneUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}"]}}],"displayName":"Get Zone by key","description":null,"queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/zones/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}"]}}],"displayName":"Delete Zone by key","description":null,"queryParameters":[{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Zone","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/zones/key={key}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"test","resourceName":"ByProjectKey","resourcePathUri":"/{projectKey}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true}],"post":null,"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResource","resourcePathUri":"/{projectKey}/resource","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}"]}}],"displayName":"Create or Update a Resource","description":"Create or Update (POST) operation to a resource.","queryParameters":null,"responses":[{"code":201,"description":"201 Created response. This is the success response when creating something.","body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"objectTypeProperty\" : {\n    \"arrayOfIntExample\" : [ 1, 2, 1, 3, 2, 3, 1 ],\n    \"arrayOfUniqueIntExample\" : [ 1, 3, 5, 7 ],\n    \"arrayOfTwonumbersExample\" : [ 3, 5 ],\n    \"arrayOfFloatExample\" : [ 0.82 ],\n    \"arrayOfNumberNoDefaultsExample\" : [ 10, 9, 8, 7, 6 ],\n    \"arrayOfStringExample\" : [ \"dog\", \"cat\", \"bird\" ],\n    \"arrayOfObjectType\" : [ {\n      \"integerExample\" : 777,\n      \"integerExampleInt32\" : 1\n    }, {\n      \"integerExample\" : 30000,\n      \"integerExampleInt32\" : 22\n    } ]\n  }\n}\nDATA"}],"body":{"applicationjson":{"type":"ObjectTestTypeDraft","builtinType":"object"}}},"put":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}"]}}],"displayName":"Create or Overwrite a Resource","description":"Create or Overwrite (PUT) operation to a resource.","queryParameters":null,"responses":[{"code":201,"description":"201 Created response. This is the success response when creating something.","body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ObjectTestTypeDraft","builtinType":"object"}}},"patch":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}"]}}],"displayName":"Overwrite a Resource","description":"Overwrite (PATCH) operation to a resource.","queryParameters":null,"responses":[{"code":201,"description":"201 Created response. This is the success response when creating something.","body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":null,"body":{"applicationjson":{"type":"ObjectTestTypeDraft","builtinType":"object"}}},"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Get all resources","description":"Query/retrieve (GET) a specific resource or resource(s). This should return a paged query result of _blah_.","queryParameters":[{"name":"stringParameter","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"floatParameter","required":false,"type":"Float","builtinType":"Float","description":null,"items":null},{"name":"integerParameter","required":false,"type":"Int","builtinType":"Int","description":null,"items":null},{"name":"withMarkdownDescription","required":false,"type":"Float","builtinType":"Float","description":"This `markdown` should be parsed correctly.","items":null},{"name":"objectParameter","required":false,"type":"ObjectTestType","builtinType":"ObjectTestType","description":null,"items":null},{"name":"arrayOfString","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"arrayOfStringWithDescription","required":false,"type":"array","builtinType":"array","description":"This should render above the text \"The parameter can be passed multiple times.\"","items":{"type":"string"}}],"responses":[{"code":200,"description":"A 200 response.  This is the case when reading or modifying something.","body":{"applicationjson":{"type":"ArrayTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Check for existence","description":"Check if at least one resource exists matching the query condition.","queryParameters":[{"name":"stringParameter","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"floatParameter","required":false,"type":"Float","builtinType":"Float","description":null,"items":null},{"name":"integerParameter","required":false,"type":"Int","builtinType":"Int","description":null,"items":null},{"name":"withMarkdownDescription","required":false,"type":"Float","builtinType":"Float","description":"This `markdown` should be parsed correctly.","items":null},{"name":"objectParameter","required":false,"type":"ObjectTestType","builtinType":"ObjectTestType","description":null,"items":null},{"name":"arrayOfString","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"string"}},{"name":"arrayOfStringWithDescription","required":false,"type":"array","builtinType":"array","description":"This should render above the text \"The parameter can be passed multiple times.\"","items":{"type":"string"}}],"responses":[{"code":200,"description":"A 200 response.  This is the case when reading or modifying something.","body":null}],"codeExamples":[{"language":"curl","value":"curl -X HEAD https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResourceArtificiallyComplexPathUriParameterOneByUriParameterOneByUriParameterTwo","resourcePathUri":"/{projectKey}/resource/artificially-complex/path/uri-parameter-one={uriParameterOne}/{uriParameterTwo}","description":"Artificial Endpoint constructing a high complexity of what could theoretically come together in one API","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true},{"name":"uriParameterOne","type":"string","builtinType":"string","description":"A Path parameter in the equal-sign-pseudo-query notation","required":true},{"name":"uriParameterTwo","type":"string","builtinType":"string","description":"A Path parameter as a plain variable path element","required":true}],"post":{"securedBy":null,"displayName":null,"description":"Updates the resource. OutOfOrderPropertiesTestType is used because it is big and long.","queryParameters":[{"name":"queryParameterOne","required":false,"type":"Float","builtinType":"Float","description":"some parameter to construct a combination of URI and query params","items":null},{"name":"queryParameterTwo","required":false,"type":"string","builtinType":"string","description":null,"items":null}],"responses":[{"code":200,"description":"ArrayTestType is used because it is big and long.","body":{"applicationjson":{"type":"ArrayTestType","builtinType":"object"}}},{"code":202,"description":"DateTestType is used because it is big and long\nThis is not used by commercetools but a valid 2xx response that says that it will process the stuff later.\nIt's here to check how we handle multiple \"OK\" style response options.","body":{"applicationjson":{"type":"DateTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/artificially-complex/path/uri-parameter-one={uriParameterOne}/{uriParameterTwo} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"eigthProperty\" : \"Should display 8th (1st in RAML)\",\n  \"createdBy\" : {\n    \"firstName\" : \"John\",\n    \"lastName\" : \"Doe\"\n  },\n  \"ninthProperty\" : \"Should display 9th (3rd in RAML)\",\n  \"key\" : \"Should display 3rd (4th in RAML)\",\n  \"tenthProperty\" : \"Should display 10th (5th in RAML)\",\n  \"custom\" : \"Should display 16th (6th in RAML)\",\n  \"eleventhPropery\" : \"Should display 11th (7th in RAML)\",\n  \"id\" : \"Should display 1st (8th in RAML)\",\n  \"twelthProperty\" : \"Should display 12th (9th in RAML)\",\n  \"lastModifiedBy\" : {\n    \"firstName\" : \"Jane\",\n    \"lastName\" : \"Doe\"\n  },\n  \"thirteenthProperty\" : \"Should display 13th (11th in RAML)\",\n  \"lastModifiedAt\" : \"2016-02-28T16:41:41.090Z\",\n  \"fourteenthProperty\" : \"Should display 14th (13th in RAML)\",\n  \"fifteenthProperty\" : \"Should display 15th (14th in definition)\",\n  \"createdAt\" : \"2015-02-28T16:41:41.090Z\",\n  \"version\" : \"Should display 2nd (16th in RAML)\"\n}\nDATA"}],"body":{"applicationjson":{"type":"OutOfOrderPropertiesTestType","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResourceById","resourcePathUri":"/{projectKey}/resource/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true},{"name":"id","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":null,"displayName":"Update a Resource by ID","description":"Update a resource by ID","queryParameters":null,"responses":null,"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"doSomeThing\"\n  }, {\n    \"action\" : \"changeSomeProperty\",\n    \"someProperty\" : \"any string\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"ExampleResourceUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Get a Resource by its ID","description":"Query by ID","queryParameters":[{"name":"optionalQueryParameter","required":false,"type":"string","builtinType":"string","description":"This is a query parameter.","items":null},{"name":"secondOptionalQueryParameter","required":false,"type":"string","builtinType":"string","description":"This is another query parameter.","items":null}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}"]}}],"displayName":"Delete a Resource by its ID","description":"Deletes a resource.","queryParameters":null,"responses":[{"code":200,"description":"Deletion was successful.","body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"test","resourceName":"ByProjectKeyResourceDescriptionWithUrnLinks","resourcePathUri":"/{projectKey}/resource/description-with-urn-links","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true}],"post":{"securedBy":null,"displayName":null,"description":"This link - [ObjectTestTypeDraft](ctp:test:type:ObjectTestTypeDraft), `[ObjectTestTypeDraft](ctp:test:type:ObjectTestTypeDraft)`, must be auto-generated.","queryParameters":[{"name":"queryParameterOne","required":false,"type":"Float","builtinType":"Float","description":"This link - [StringTestType](ctp:test:type:StringTestType), `[StringTestType](ctp:test:type:StringTestType)`, must be auto-generated.","items":null},{"name":"queryParameterTwo","required":false,"type":"string","builtinType":"string","description":null,"items":null}],"responses":[{"code":200,"description":"ArrayTestType is used because it is big and long.","body":{"applicationjson":{"type":"ArrayTestType","builtinType":"object"}}},{"code":202,"description":"DateTestType is used because it is big and long\nThis is not used by commercetools but a valid 2xx response that says that it will process the stuff later.\nIt's here to check how we handle multiple \"OK\" style response options.","body":{"applicationjson":{"type":"DateTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/description-with-urn-links -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"eigthProperty\" : \"Should display 8th (1st in RAML)\",\n  \"createdBy\" : {\n    \"firstName\" : \"John\",\n    \"lastName\" : \"Doe\"\n  },\n  \"ninthProperty\" : \"Should display 9th (3rd in RAML)\",\n  \"key\" : \"Should display 3rd (4th in RAML)\",\n  \"tenthProperty\" : \"Should display 10th (5th in RAML)\",\n  \"custom\" : \"Should display 16th (6th in RAML)\",\n  \"eleventhPropery\" : \"Should display 11th (7th in RAML)\",\n  \"id\" : \"Should display 1st (8th in RAML)\",\n  \"twelthProperty\" : \"Should display 12th (9th in RAML)\",\n  \"lastModifiedBy\" : {\n    \"firstName\" : \"Jane\",\n    \"lastName\" : \"Doe\"\n  },\n  \"thirteenthProperty\" : \"Should display 13th (11th in RAML)\",\n  \"lastModifiedAt\" : \"2016-02-28T16:41:41.090Z\",\n  \"fourteenthProperty\" : \"Should display 14th (13th in RAML)\",\n  \"fifteenthProperty\" : \"Should display 15th (14th in definition)\",\n  \"createdAt\" : \"2015-02-28T16:41:41.090Z\",\n  \"version\" : \"Should display 2nd (16th in RAML)\"\n}\nDATA"}],"body":{"applicationjson":{"type":"OutOfOrderPropertiesTestType","builtinType":"object"}}},"put":null,"patch":null,"get":null,"head":null,"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResourceKeyByKey","resourcePathUri":"/{projectKey}/resource/key={key}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true},{"name":"key","type":"string","builtinType":"string","description":null,"required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Get a Resource by its Key","description":"Query by key. Has three responses to see the difference between modeling patterns in RAML","queryParameters":null,"responses":[{"code":200,"description":"this is directly using a named type without messing with it, thats how we want to use RAML","body":{"applicationjson":{"type":"ObjectTestType","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/key={key} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResourceSearchApiPattern","resourcePathUri":"/{projectKey}/resource/searchApiPattern","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Search Resources","description":"Search all resources by specific parameters.","queryParameters":[{"name":"fuzzy","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to apply fuzzy search on the text to analyze.","items":null},{"name":"fuzzyLevel","required":false,"type":"Float","builtinType":"Float","description":"Provide explicitly the fuzzy level desired if fuzzy is enabled. This value can not be higher than the one\nchosen by the platform by default.","items":null},{"name":"staged","required":false,"type":"boolean","builtinType":"boolean","description":"Whether to query for the current or staged projections.","items":null},{"name":"filter","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"filter.facets","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"filter.query","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"facet","required":false,"type":"string","builtinType":"string","description":null,"items":null},{"name":"/text.[a-z]{2}(-[A-Z]{2})?/","required":false,"type":"string","builtinType":"string","description":null,"items":null}],"responses":null,"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/searchApiPattern -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"test","resourceName":"ByProjectKeyResourceSortedQueryParameters","resourcePathUri":"/{projectKey}/resource/sorted-query-parameters","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"The CTP project key.","required":true}],"post":null,"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["manage_test:{projectKey}","view_test:{projectKey}"]}}],"displayName":"Sorted Query Parameters","description":"Query parameters should be sorted as in the description of each parameter.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":"Should display 1st (2nd in RAML)","items":{"type":"ObjectTestType"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":"Should display 2nd (3rd in RAML)","items":{"type":"ObjectTestType"}},{"name":"limit","required":false,"type":"Float","builtinType":"Float","description":"Should display 3rd (4th in RAML)","items":null},{"name":"offset","required":false,"type":"Float","builtinType":"Float","description":"Should display 4th (5th in RAML)","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Should display 5th (7th in RAML)","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":"Should display 6th (1st in RAML)","items":{"type":"ObjectTestType"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"Should display 7th (6th in RAML)","items":{"type":"string"}}],"responses":null,"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.{cloudProvider}.commercetools.com/{projectKey}/resource/sorted-query-parameters -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumber","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"orderNumber","type":"string","builtinType":"string","description":"`orderNumber` of the [Order](ctp:api:type:Order).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Update order by order number in store","description":"Updates an order in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\nIn case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+,\nit should be provided in URL-encoded format.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeOrderState\",\n    \"orderState\" : \"Complete\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get order by order number in store","description":"Returns an order by its order number from a specific Store.\nThe {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\nIn case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+,\nit should be provided in URL-encoded format.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Delete order by order number in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyOrdersById","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/orders/{id}","description":null,"uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true},{"name":"id","type":"string","builtinType":"string","description":"`id` of the [Order](ctp:api:type:Order).","required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Update order by id in store","description":"Updates an order in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"changeOrderState\",\n    \"orderState\" : \"Complete\"\n  } ]\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderUpdate","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Get order by id in store","description":"Returns an order by its ID from a specific Store. The {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Delete order by id in store","description":null,"queryParameters":[{"name":"dataErasure","required":false,"type":"boolean","builtinType":"boolean","description":null,"items":null},{"name":"version","required":true,"type":"Int","builtinType":"Int","description":"Last seen version of the resource","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}?version={version} -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]}},{"apiKey":"api","resourceName":"ByProjectKeyInStoreKeyByStoreKeyOrders","resourcePathUri":"/{projectKey}/in-store/key={storeKey}/orders","description":"An order can be created from a cart, usually after a checkout process has been completed.","uriParameters":[{"name":"projectKey","type":"string","builtinType":"string","description":"`key` of the [Project](/../api/projects/project#project).","required":true},{"name":"storeKey","type":"string","builtinType":"string","description":null,"required":true}],"post":{"securedBy":[{"oauth_2_0":{"scopes":["manage_orders:{projectKey}","manage_orders:{projectKey}:{storeKey}"]}}],"displayName":"Create order in store","description":"Creates an order from a Cart from a specific Store. The {storeKey} path parameter maps to a Store's key.\nWhen using this endpoint the orders's store field is always set to the store specified in the path parameter.\nThe cart must have a shipping address set before creating an order. When using the Platform TaxMode,\nthe shipping address is used for tax calculation.","queryParameters":[{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}}],"responses":[{"code":201,"description":null,"body":{"applicationjson":{"type":"Order","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X POST https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}' \\\n--header 'Content-Type: application/json' \\\n--data-binary @- << DATA \n{\n  \"id\" : \"7c2e2694-aefe-43d7-888e-6a99514caaca\",\n  \"version\" : 10,\n  \"orderNumber\" : \"201612010001\"\n}\nDATA"}],"body":{"applicationjson":{"type":"OrderFromCartDraft","builtinType":"object"}}},"put":null,"patch":null,"get":{"securedBy":[{"oauth_2_0":{"scopes":["view_orders:{projectKey}","view_orders:{projectKey}:{storeKey}"]}}],"displayName":"Query orders in store","description":"Queries orders in a specific Store. The {storeKey} path parameter maps to a Store's key.","queryParameters":[{"name":"where","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"QueryPredicate"}},{"name":"sort","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Sort"}},{"name":"limit","required":false,"type":"Int","builtinType":"Int","description":"Number of results [returned](/../api/general-concepts#limit).","items":null},{"name":"offset","required":false,"type":"Int","builtinType":"Int","description":"Number of results [skipped](/../api/general-concepts#offset).","items":null},{"name":"withTotal","required":false,"type":"boolean","builtinType":"boolean","description":"Calculate [total](/../api/general-concepts#total) number of results.","items":null},{"name":"expand","required":false,"type":"array","builtinType":"array","description":null,"items":{"type":"Expansion"}},{"name":"/^var[.][a-zA-Z0-9]+$/","required":false,"type":"array","builtinType":"array","description":"[Predicate parameter](/../api/predicates/query#input-variables) values.","items":{"type":"string"}}],"responses":[{"code":200,"description":null,"body":{"applicationjson":{"type":"OrderPagedQueryResponse","builtinType":"object"}}}],"codeExamples":[{"language":"curl","value":"curl -X GET https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders -i \\\n--header 'Authorization: Bearer ${BEARER_TOKEN}'"}]},"head":null,"delete":null}]}}}