{ "openapi": "3.0.4", "info": { "title": "Umbraco Commerce Storefront API", "description": "Describes the Umbraco Commerce Storefront API, the front end headless API for Umbraco Commerce cart management and checkout processing.", "version": "Latest" }, "paths": { "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/pay/{token}": { "get": { "tags": [ "Checkout (Hosted)" ], "summary": "Starts the hosted payment process", "description": "Redirects to the given Orders selected payment gateway for payment processing.

If in `Framed` mode should be redirected to as normal, or if in `Framed` mode, the endpoint URL should be launched in a WebView/iframe and developers should watch for changes in the URL to detect the outcome of the transaction. Final endpoint URLs will be one of `{endpointUrl}/completed`, `{endpointUrl}/canceled` or `{endpointUrl}/errored`. If launched in an iframe from a web context, you can also register a `message` event handler to get notified of the final status. Messages will be in the format `UC:{orderId}:{token}:{status}`", "operationId": "pay", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order being checked out", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "927dde27-4b3f-4223-9c89-1b0d25fadf0f" }, { "name": "token", "in": "path", "description": "The checkout token for the checkout session", "required": true, "schema": { "type": "string" }, "example": "d84581c4-135e-41a0-ba92-38d3d6002661" } ], "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/token": { "get": { "tags": [ "Checkout (Hosted)" ], "summary": "Initialize a hosted checkout flow", "description": "Initialization prepares the order for checkout and produces a token to be passed to the `/pay` endpoint.", "operationId": "token", "parameters": [ { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f14ca31d-3dc2-4fae-86eb-8676de0d0238" }, "Entity Alias": { "value": "blendid" } } }, { "name": "orderId", "in": "path", "description": "The ID of the order being checked out", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "bd7eb675-0fd8-4d32-b855-c1db06db6348" }, { "name": "Origin", "in": "header", "description": "The base URL the checkout request originates from. Used on the checkout status pages to securly post messages back to a parent window about the checkout status.", "schema": { "type": "string" }, "example": "https://www.example.com" }, { "name": "Mode", "in": "header", "description": "Sets the mode the checkout should run in, either `Redirect` (default) which follows the regular full redirect approach and after payment returns to the configured URL's in the payment provider settings, or `Framed` where it is assumed the checkout will be opened in a WebView/iframe and the status of the container monitored.", "schema": { "type": "string" }, "examples": { "Redirect": { "value": "Redirect" }, "Framed": { "value": "Framed" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutTokenDto" } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/confirm": { "post": { "tags": [ "Checkout (Inline)" ], "summary": "Confirms an inline checkout flow", "description": "Updates the given Orders transaction info with the supplied details and transitions the order from a `open` to a `finalized` state", "operationId": "confirm", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "53df8d21-a3ce-4646-955e-96394cde5206" }, "Entity Alias": { "value": "blendid" } } }, { "name": "orderId", "in": "path", "description": "The ID of the order being checked out", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "fa6d97a5-737b-448b-9809-5d719338d4df" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutConfirmRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutConfirmDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } }, "404": { "description": "Not Found", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/initialize": { "get": { "tags": [ "Checkout (Inline)" ], "summary": "Initialize an inline checkout flow", "description": "With inline checkout flow it's the developers responsibility to capture the transaction and confirm the payment via the `/confirm` endpoint. The selected payment methods setting are returned to ease payment gateway configuation, along with details of any meta data the payment method expects to be captured.", "operationId": "initialize", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1b82c2c3-c80b-47ae-aed6-627f5cdec050" }, "Entity Alias": { "value": "blendid" } } }, { "name": "orderId", "in": "path", "description": "The ID of the order being checked out", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "54a5385f-6af0-4706-b77d-eb01e52e2f90" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutInitializedDto" } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/paymentmethods": { "get": { "tags": [ "Checkout" ], "summary": "Get valid Payment Methods and their fees for a given Order", "operationId": "getValidPaymentMethodsByOrderId", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "9983bd5f-d98f-4e50-835b-6b2fad896bc5" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "687af679-dc9a-4503-9c05-be9a725395bd" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d6e89f57-cb7e-4ff3-b363-4eea3e7a1af8" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2a56a63e-b23e-4980-9870-fd4d354b8b28" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7a549961-f76a-4648-b775-88a66e12a1c3" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e9fc03d4-b7ba-4ab2-a866-0ebd855c1b6a" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3d84baf2-dc01-49ec-9cc5-e5fa56a004a9" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b83e1b40-49ee-4a09-95ca-190cc51ed4c5" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_1b47ad97-a6c7-48fc-be77-62c58e1141b6" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "ba092b14-95a7-4a4f-85e1-e6c67f5c9d1c" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodWithFeeDto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/checkout/{orderId}/shippingmethods": { "get": { "tags": [ "Checkout" ], "summary": "Get valid Shipping Methods and their rates for a given Order", "operationId": "getValidShippingMethodsByOrderId", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d4dc3b28-4c2b-4ca9-be38-9f11cc81a71e" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "b93cc37f-b776-4925-8e59-3b1c814fc1c7" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "aa481108-8233-462e-8a3f-110490a2cbd8" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1e3f59bd-ca2a-4f40-9820-d29d755f423c" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "50b508c6-77fc-462f-be9b-f70f42aa3612" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "66b1e1a6-aa3b-4fa1-a189-3dfd88443739" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "48cbd94f-57b5-47f9-976b-c425b33a3c54" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b1d7ae49-9f3e-4e4d-9e4a-6da277aa6813" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_816847ed-ae38-4711-96d7-133f500b64a2" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2ed9e93f-d381-4ae7-a766-4b3a34a1b825" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodWithRatesDto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/delivery/api/v1/content/item/{id}/variant": { "get": { "tags": [ "Content" ], "summary": "Gets a multi-variants content", "description": "By default the variants property editor from Umbraco Commerce will only return attribute information with a product node to save on excessive payload sizes. The variants endpoint can be called to dynamically fetch an attibute combinations content only when it is requested.", "operationId": "getVariant", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the content item that has an Umbraco Commerce variants property editor defined on it", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "dbf88b95-f3d0-4cbe-9edc-55fecd14ba80" }, { "name": "attribute", "in": "query", "description": "The attribute combination of the variant to return", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.", "schema": { "type": "string" }, "examples": { "Expand none": { "value": "" }, "Expand all": { "value": "all" }, "Expand specific property": { "value": "property:alias1" }, "Expand specific properties": { "value": "property:alias1,alias2" } } }, { "name": "Accept-Language", "in": "header", "description": "Defines the language to return. Use this when querying language variant content items.", "schema": { "type": "string" }, "examples": { "Default": { "value": "" }, "English culture": { "value": "en-us" } } }, { "name": "Accept-Segment", "in": "header", "description": "Defines the segment to return. Use this when querying segment variant content items.", "schema": { "type": "string" }, "examples": { "Default": { "value": "" }, "Segment One": { "value": "segment-one" } } }, { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "schema": { "type": "string" } }, { "name": "Preview", "in": "header", "description": "Whether to request draft content.", "schema": { "type": "boolean" } }, { "name": "Start-Item", "in": "header", "description": "URL segment or GUID of a root content item.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProductVariantItemDto" } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/countries": { "get": { "tags": [ "Country" ], "summary": "Gets all the Countries in a Store", "operationId": "searchCountries", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "35f0ddcb-3fdf-47a5-97aa-e71713a5243f" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "c6d81985-ae49-4bf6-b0ef-a08762b2e5e7" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f298a21c-0cbb-433a-aa9e-48ead7625cfd" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bf5076f8-2ba2-4347-b33a-cae7810aa046" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "15c85dbf-200c-4ca9-981c-a4b588e7b351" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d90850da-1664-49bd-826d-710100b9995e" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bb133cd8-36af-4ac2-84a0-cb92ac7886e5" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8b7dae01-1c1c-41e3-b245-1ff3b3b0ed62" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_bb22aa9f-862d-4474-865a-ccf3c869c16e" }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods": { "get": { "tags": [ "Country" ], "summary": "Gets the Payment Methods allowed in a Region", "operationId": "getPaymentMethodsByCountryIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e39b56d1-fffa-47aa-b877-a0933b0564a0" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "5a8ac4c6-82de-492f-b910-12c7aee2111c" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2c0ab950-a40f-469b-8acc-467b8d487602" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2a0e08b2-b63e-4753-9e97-56347c453e36" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f4226516-b4df-4d66-988b-2153a89165f4" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1c82719c-3dbf-451e-afbb-8cd2edfb742e" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "467a204d-7693-43fe-839e-4e298c1f2f41" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c7b82ff6-6e99-450a-9d31-b236f5b12177" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_fef089d5-5c6f-4b7e-b5f5-eecc01261f94" }, { "name": "countryIdOrAlias", "in": "path", "description": "The ID or the alias of the country resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "d33bce89-6bf6-4798-8a9a-065f1916c532" }, "Entity Alias": { "value": "alias" } } }, { "name": "regionIdOrAlias", "in": "path", "description": "The ID or the alias of the region resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "39651e0f-ae8c-457f-81ec-066d5ba89f53" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/shippingmethods": { "get": { "tags": [ "Country" ], "summary": "Gets the Shipping Methods allowed in a Region", "operationId": "getShippingMethodsByCountryIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8a34b661-5fd6-479d-9273-62e75869a6e3" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "f9346392-295c-4ab5-91e7-a4a37c0e77e7" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a1efc63e-cc3d-46e6-8e21-1316b293c138" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c15f1859-7be4-48dc-a579-7044d79290d0" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "28eeb217-0b77-4732-8e81-d9d23e1eba68" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c448ea54-8ebe-40db-8886-c55d2d6cc342" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "cd604832-226e-4f4e-b11e-a4a11c38c43c" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "664b2f24-6a8e-4b00-a2fd-2d18933b5965" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_a2a9c56d-034c-4768-a325-334b73745964" }, { "name": "countryIdOrAlias", "in": "path", "description": "The ID or the alias of the country resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "1a81a307-0ce0-472c-8e6c-4faa6574b223" }, "Entity Alias": { "value": "alias" } } }, { "name": "regionIdOrAlias", "in": "path", "description": "The ID or the alias of the region resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "37ee75a4-c448-4a8d-96dd-2741f7c4bd5e" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v1/country/{idOrAlias}": { "get": { "tags": [ "Country" ], "summary": "Gets a Country by ID or Alias", "operationId": "getCountryByIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f493cfe1-c9fd-4d88-90c5-5faee179b1a3" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "af3bdd29-55fb-4c10-9cb3-94200d45a421" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f6486c0b-65d3-4bc4-97b0-ae0ddcd2172f" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6efdd905-da95-48be-b6c6-0efbd0cd7a35" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3947afc5-b854-470c-8c7b-108295cca9c2" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "eacd9832-1618-4fd7-8a2d-63cc0c52cc03" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4ae1a88c-d628-42bc-be77-185e739de1c0" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "093ac173-15c3-48d6-8115-921acb406165" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_50614798-6712-4de6-807d-86c94c920fdb" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "d3c9d1fb-6cdd-4438-8700-8e7ea9686281" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" } ] } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies": { "get": { "tags": [ "Country" ], "summary": "Gets the Currencies allowed in a Country", "operationId": "getCurrenciesByCountryIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b5c11102-9930-4be8-b91f-358519b84064" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "39d2b1d8-b389-487a-bbdd-80b7a1e66482" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a0726142-f854-470f-8c32-8b348795c692" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "9b01a8e2-a29e-45d4-a8ac-6c017991d131" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b5ea9291-d70d-4bbb-869b-59a2e3190c3b" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "736b677b-446b-4dec-8f4d-867255b0ab21" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "88ae3947-ca0b-45bc-86bb-117d3a93aa5c" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e3ed4d92-c44b-4b0b-8285-93492cbccf59" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_ace51d82-f47f-44d6-b0fc-10e4e0b7a17d" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "ecbb63d5-3904-49b5-b5b3-6644383e3375" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods": { "get": { "tags": [ "Country" ], "summary": "Gets the Payment Methods allowed in a Country", "operationId": "getPaymentMethodsByCountryIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0cb9830b-8d32-4f54-9d40-9c5975f39f02" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "30609367-ed31-4c92-b2d2-8f18637f3537" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "55328b9c-c97e-4b84-9c95-782e4971099e" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7487d3c0-a170-4d8b-8783-9a98777c4c46" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "014d257e-7f54-4b81-9307-3d8895eb7eac" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ee7fb2aa-7f0a-42d6-9b4e-ffc4d5aa3ee5" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "76641ac1-ee78-4b71-9aae-5e93711446b4" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "075d035f-cb92-4125-8dff-63556f172829" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_47951dca-f564-4a4c-8464-16da4c099589" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "ca54877f-7936-4fcd-ac92-cf92c7868549" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods": { "get": { "tags": [ "Country" ], "summary": "Gets the Shipping Methods allowed in a Country", "operationId": "getShippingMethodsByCountryIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "38c48fc6-8929-4dd6-bbbb-133ca9cdd871" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "9254fd38-0fe0-488f-9a07-285014044329" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "75b94aeb-e0f5-4341-b6c6-8a2e6daf3daf" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f2668edc-ca71-44aa-ad44-866f43328ec5" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0be9b7e8-7692-48c9-a700-29a27e8ce69c" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ead01bf6-bc8a-43f8-b3bc-654ac4ca1111" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "156b29fc-6f7e-4d62-85a8-70dff977993a" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "502ea25d-af9c-4056-9b25-8a3bec9b509b" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_9ad9508b-2ffe-4e68-b4bc-cf609cf5ee43" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "8c053646-7805-4a9e-a217-2eef90330a0b" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v1/currencies": { "get": { "tags": [ "Currency" ], "summary": "Gets all the Currencies in a Store", "operationId": "searchCurrencies", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "80f81489-0a0e-4d51-b7ce-0a499f56eed2" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "82e86f75-9928-4395-b9f0-addadc385bf2" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "011be31f-063d-4d4d-97e2-d2ff5fb04fc5" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e0a1625b-16ae-4084-8cbf-393ab0ade07c" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "9dc0c386-0f06-480e-aaa9-7d1d23ffb2fe" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "67f2bb55-c9af-4c27-a526-a9ad9070a875" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "cbcfe84c-780b-46c7-bbbd-f6a99e574d1f" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "84908219-7564-44b5-b055-ff0025176901" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_2a7c0334-632d-4256-abbf-a83626f3ba48" }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/currency/{idOrAlias}": { "get": { "tags": [ "Currency" ], "summary": "Gets a Currency by ID or Alias", "operationId": "getCurrencyByIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2cce5d4a-5393-4554-ac24-f11e2f764a3e" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "1cc7acdf-ba1a-4903-acc4-014796b0ddab" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8ef9d1b6-2ab6-46fa-ab10-5f15373cafad" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4271edf5-74c8-4092-bfe5-612b439a7029" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7fc5d05b-1592-4fb3-8d26-adb14adae570" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "eca82ab7-2a2b-4d7a-a7f0-05ec3295dfc4" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bbb8153e-b8f1-4b60-a5a1-90c16a9233d0" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "88269849-bec4-4c19-b3a0-68220fc756e5" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_83c0d615-0884-48c6-b768-67888995fb9e" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "71409002-2cb6-4910-9cf0-fa1a3534abb8" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" } ] } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/customer/{customerReferenceOrEmail}/orders": { "get": { "tags": [ "Customer" ], "summary": "Gets all the finalized Order of a Customer", "operationId": "getCustomerOrders", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "95255d21-4ffa-4b04-96dd-64eb6bd9f78d" }, "Entity Alias": { "value": "blendid" } } }, { "name": "customerReferenceOrEmail", "in": "path", "description": "A custom reference or email of an existing customer. Can be UrlBase64 encoded.", "required": true, "schema": { "type": "string" }, "example": "cust_11437c66-dda5-496a-a982-f3af39dcabe9" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}": { "post": { "tags": [ "Order" ], "summary": "Adds a product to an Order", "operationId": "addProductToOrder", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "46c138e7-3d90-460d-a2f4-4425ead88e3e" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "af33235d-8721-4439-b38e-fde1306cc8a0" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b2b9fefa-2b3d-442d-9195-59d32cc0e843" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b420e182-6bcd-4104-8380-d326bc0904e4" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e241dae3-b2ea-4c7e-acc2-0967a61502da" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "643e3703-1864-425d-9952-e624d61d99c9" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "800e1790-53ba-49dc-969d-effea2c0da1b" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "327fa46c-fd30-45bf-9e21-992dbc457f5f" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_81bed500-149e-4e4d-b6cb-62645e34cbed" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "ebe4da35-ab66-4889-b308-cb29acad45c7" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AddProductRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "delete": { "tags": [ "Order" ], "summary": "Deletes an Order", "operationId": "deleteOrder", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3d4409a6-bb97-4d01-8ef3-2f6631a88e77" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "843e86a5-0508-4208-8754-15aff9308bd2" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bf06f421-bffb-4449-9aed-9858943c111d" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "94355c64-5164-4bdb-a934-f4e2867e69e0" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3c24828c-eac1-4e90-8f07-c9cb0ec2305d" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "91080bc8-1147-48f5-b36e-98225752a7bb" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "13061b78-3ad2-4563-b6fc-11b845393a65" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7a094d1b-9f1c-42f7-a0e8-d0c8e6953512" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_1fc7f6a7-1cb1-426c-956c-b961bdd5532f" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "762231ee-2a18-4dfb-b856-3cc6b262b997" } ], "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "get": { "tags": [ "Order" ], "summary": "Gets an Order by ID", "operationId": "getOrderById", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "75326aeb-bf6c-4832-ae81-aa3f176099fd" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "f7886d8c-ba8a-404a-8f04-2cbd70a749e1" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e611b651-5334-45f8-a507-47e5ce965429" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e653e16d-a52e-4406-b52e-5b01fd731ef7" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "67b4751b-02ab-4781-aa28-0382a58f1bde" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "cf98a388-65d9-4932-be15-7509b7c9f762" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "143b6444-c66f-4935-90fd-69d7e0943590" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7f62d5d1-510e-49a3-ac54-ac8dd00008be" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_fa3abd6b-4239-4e06-b52b-e4d56e8ba563" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "36e0f503-e394-4fbc-963a-0896f41726a9" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Order" ], "summary": "Updates an Order", "operationId": "updateOrder", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "46ab8e78-374e-4ef6-bc6f-3946bea0533e" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "ffffebed-2e88-4931-8eac-6549012730a7" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "876c761b-35f0-4436-8fab-f13bd9b44913" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "935578af-82c1-40a5-9be6-923f2de821a5" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4751f44e-6118-46ad-a3c5-eeef3093e015" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "75a62218-7ebc-4a60-9ff4-66997c0f1b4b" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ed22a9e9-5671-4c0a-bc3a-9b9ffd8d0b9e" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e157e347-3311-4fb0-8ae2-b133c185af7f" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_2551e6a2-1817-4fcf-9901-ead3d1a02fac" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "ae0c74ee-7129-463c-94f2-4c55448b745c" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}": { "post": { "tags": [ "Order" ], "summary": "Adds a product to a Bundle", "operationId": "addProductToBundle", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "abf036db-d7da-41c7-977d-647cbd1ab5a5" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "d19aa62e-80cf-4313-bc25-b11e4d656a20" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c087e3c6-9789-4cb0-b7be-7534557219e3" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a0329d00-2924-4173-a448-6f7d59ba7055" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "be9183d3-04a2-411e-84f4-2fdeec0df883" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "034a503d-051c-4c44-b778-01eb93453eb9" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0b872666-f234-4108-945f-deddb4b6e14c" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7b8e29a7-1255-4eef-82cf-2eee660ad534" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_617750b3-370e-4cd8-a2c5-cf7d2cc66f96" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "74df7ee0-dcc8-4004-982b-7d1429cd9d6e" }, { "name": "bundleId", "in": "path", "description": "The ID of the bundle", "required": true, "schema": { "type": "string" }, "example": "71b0d561-b3c6-4601-b478-20e942aa1124" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AddProductRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/item/{orderLineId}": { "delete": { "tags": [ "Order" ], "summary": "Deletes an Order Line in a Bundle", "operationId": "deleteBundleOrderLine", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "cee85b63-2f4a-4632-ac59-e04bc51ce430" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "cf8b81b0-ecf4-4c04-a4d3-d84b0a1dcbf8" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f88740ed-e5e6-4afd-80c4-7becbbdcbc91" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "87b11d9e-8b19-4837-aad8-a21d420de768" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "58ef07d4-591f-457e-9b18-f71335610d56" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e44e78c6-cfc3-4153-8a17-cb9c604d6722" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a820008b-7c9c-446c-9a78-f4b063089627" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "075a4d2b-378e-4e29-94f2-74be3f7a3ad3" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_f5f11a1f-45eb-415a-b5e6-e583c8a8e64a" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "6e020930-a659-4856-847c-10e97afa0391" }, { "name": "bundleId", "in": "path", "description": "The ID of the bundle", "required": true, "schema": { "type": "string" }, "example": "87cafb58-7ae6-4397-b577-023374320b10" }, { "name": "orderLineId", "in": "path", "description": "The ID of the order line", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "41dc953b-752d-4945-be5e-171878fc7fe5" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "patch": { "tags": [ "Order" ], "summary": "Updates an Order Line in a Bundle", "operationId": "updateBundleOrderLine", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4033face-d845-4d9f-b065-e2e6dcd0a9ca" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "7f64b2d4-1e80-4f7a-bcba-29a7f736f38d" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f2663a86-5486-4d0a-aae8-e0680a734904" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6c1ce1e5-b894-4035-8f64-f168434fdd8e" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b165df03-4b3e-4441-8305-95a8ce7a974a" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "842201cc-468f-4ff0-942c-42db90e3679a" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f0d1f303-359a-42a7-9f09-170be7fb3226" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b390f155-acea-40bb-b00c-07d09dd0e5a2" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_27c454a4-9660-4c07-901c-77488a41c798" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "cff6e6a8-0189-49f6-bebd-7e3ef2c61ffb" }, { "name": "bundleId", "in": "path", "description": "The ID of the bundle", "required": true, "schema": { "type": "string" }, "example": "9db9c8d7-8c89-4726-a4be-cd01004f271a" }, { "name": "orderLineId", "in": "path", "description": "The ID of the order line", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3cff5164-1a35-40ed-8eed-cce0e1246073" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderLineRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/items": { "delete": { "tags": [ "Order" ], "summary": "Deletes all Order Lines in a Bundle", "operationId": "deleteAllBundleOrderLines", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "69c1991f-ccef-4616-92c6-3e5d47960182" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "bf2a8760-4bb7-4a25-bfbc-3cf0e3c65236" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "498f94d3-840b-4709-907f-9fdffdc1a99b" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "95bf97f9-aec1-48a3-adf6-abd4fc442077" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ac7f2d5c-cbe1-455e-ae4d-1888a004e171" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "5c7fc92f-032a-4827-adf4-bc91e117550e" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1d3b3821-77d5-4031-ae5b-9052967de282" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ad951983-8be4-44bf-8ed1-cdf0de7d2ef7" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_d3bd2573-96c8-4bb1-8c58-1352f9923ec6" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2fa364ea-38a7-4b80-9823-85278394d283" }, { "name": "bundleId", "in": "path", "description": "The ID of the bundle", "required": true, "schema": { "type": "string" }, "example": "1821469a-2b9f-4ab8-8507-2de60d7761c4" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "patch": { "tags": [ "Order" ], "summary": "Bulk updates Order Lines in an Order", "operationId": "updateBundleOrderLines", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "20c46e8c-bd37-410b-87c0-1527d1d1e67d" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "fba2acdc-2b85-48f7-95ef-715b1c9db158" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a56a8d87-d59c-42e0-8d23-e2efbf775048" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0a3daf87-dc7e-4257-b58a-69d8c5e556aa" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3f970860-5884-4aad-b710-c51e436bf7ee" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "87d41ce7-1464-4203-90d4-3e9a80b9f73d" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1603437b-ad40-4893-8b2f-a64b564aab9c" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bd61c4fe-54ea-4811-bb22-ac31b8e29318" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_1e636aef-7d86-4780-9175-2ebd1a2f4d5e" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "b07650a5-e3fa-48bc-a589-871c7697bf20" }, { "name": "bundleId", "in": "path", "description": "The ID of the bundle", "required": true, "schema": { "type": "string" }, "example": "592d9b75-62ab-4afc-b70b-4dd3d788aa76" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderLineWithIdRequestDto" } ] } } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}/item/{orderLineId}": { "delete": { "tags": [ "Order" ], "summary": "Deletes an Order Line in an Order", "operationId": "deleteOrderLine", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "63591881-aef1-4b87-90a5-fda353839f1a" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "c86e72eb-5731-459e-bab2-0b81912bae1f" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "dd2965cd-4207-4207-a666-d6fde7862ee3" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ebdbad78-6338-4d35-9d95-985b71103362" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "611d5287-94ff-461a-8ea6-af6da3277262" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "546c8626-517d-4d8d-8679-ada0d5f156c5" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "19bb9814-4fb7-46eb-90d2-170a114ae1e9" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bb49f738-02ac-4060-9e03-b77434dcb5ad" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_c16bb5f4-6f82-44d7-a200-405457683ab6" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "94df9db5-d666-40d2-a388-368ab6d1736b" }, { "name": "orderLineId", "in": "path", "description": "The ID of the order line", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "4d31509a-a1fc-4055-bdc6-84daee365c08" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "patch": { "tags": [ "Order" ], "summary": "Updates an Order Line in an Order", "operationId": "updateOrderLine", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b35e7295-74af-48d9-be60-68ca74513ce5" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "219564cd-3f1c-45e5-94d6-e3d6cc078b4f" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c71742a0-7d29-4e37-8995-98f11be7b848" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ab778666-110a-48b4-8e3d-367f4c48cf93" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8f3b9ec6-94a8-48fe-ad8e-69a6d13f0f51" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "98318181-bc2d-4ba4-abf3-5bfd52d93a53" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "225a20ca-a3b7-49ca-994e-65888c1972f3" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3a42c713-20b8-42f3-a8b4-7bcc9705e9cb" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_3fd33d4d-aa1b-4cd5-ace2-6101c83e1953" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "cc8d6d03-cf66-4ab6-97a6-b60af5444ebc" }, { "name": "orderLineId", "in": "path", "description": "The ID of the order line", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "18bc8b16-bd9c-48c2-8e9b-504b8c41fa17" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderLineRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{orderId}/items": { "delete": { "tags": [ "Order" ], "summary": "Deletes all Order Lines in an Order", "operationId": "deleteAllOrderLines", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "32aac83d-9d2b-4570-ab08-65e764e19881" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "99b2786d-c5d9-49c8-a5d8-7af02f4a8e51" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "85bb5871-e28d-4d03-9023-080c4d866cfe" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3fbc49e6-76e9-4776-b3aa-186b5b4a4bcc" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "13ea191f-596b-4086-a792-fd6ac151524e" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "7d21609f-4705-48c0-8cca-35b602637c39" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "53a6769d-f445-4310-9287-33160269ece0" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d6682ddc-8480-45c6-a2f2-540f8197ebdb" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_e28b0b01-4869-4786-b27d-5c4bac282a30" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "1f68d223-a4ae-4187-853e-b6bb8af71c34" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } }, "patch": { "tags": [ "Order" ], "summary": "Bulk updates Order Lines in an Order", "operationId": "updateOrderLines", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "41e064e6-bc9d-4498-ab62-ca11df50d758" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "1f316266-72a5-41d0-a544-81344903b3ed" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8e57036c-6c63-409e-a42e-baaa9acdeb63" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d9dceafc-4509-4a6c-af09-933bf2a54546" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1179ccfd-d3e4-4255-80fe-920db85d87d4" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "fb45aa6b-6ee7-4b44-9c33-2831977388a0" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3678c3b5-3dd6-49ac-be7d-510428e6fa01" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2e27abd0-78f8-4a69-86ee-212b0c1ac50a" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_548c46d9-9af7-4db5-a33a-84d6189470b8" }, { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "0d08b772-1c7f-41c2-b2cf-144510df7f73" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderLineWithIdRequestDto" } ] } } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/order/{paymentLinkToken}": { "get": { "tags": [ "Order" ], "summary": "Gets an Order by Payment Link Token", "operationId": "getOrderByPaymentLinkToken", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "dffca848-2ba0-4d52-a4e0-2d41be877aa2" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "15115006-d8d2-4cce-8f1e-8748051f4369" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2b71f1ed-01ac-4f8c-a54e-e17dde1895bc" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d8e88788-ac39-45b9-94cc-869fd05f9487" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6a7d7adc-ad58-4db1-9410-0b7a46e2c202" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "bbc79a7c-c4cc-4471-a1d3-b1a185fd70ae" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ee7cd2cc-63b2-48a0-b3e5-f06b2c2c4c83" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "33aef002-e2d3-4498-a2be-c3ff295e0a4b" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_909590a2-363f-439c-b95c-9a603c43ebab" }, { "name": "paymentLinkToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/orders": { "post": { "tags": [ "Order" ], "summary": "Creates a new Order", "operationId": "createOrder", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "55efadc2-9431-4933-b110-55f6f0c82051" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "da5492b5-cedd-496d-a957-12a7f2c5e612" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a4fc6dd7-1347-42ab-8c21-bcbac24f9ec1" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ad6baf8e-fa79-46e7-be3f-db03b8f5cccb" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "12ec97d0-4cb0-4b92-8818-1a4d4035eea0" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d816b023-894d-4661-b694-9a67cb1ffee8" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c134f478-1914-4669-83be-6f56242c5d82" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "48a481b8-5a58-419c-955a-ba3497e0c174" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_4ed3939e-9a1a-44e3-9301-df0db67c41bb" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateOrderRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderDto" } ] } } } }, "400": { "description": "Bad Request", "headers": { "Umb-Notifications": { "description": "The list of notifications produced during the request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationHeaderModel" }, "nullable": true } } } } } } }, "/umbraco/commerce/storefront/api/v1/paymentmethod/{idOrAlias}": { "get": { "tags": [ "Payment Method" ], "summary": "Get a Payment Method by ID or Alias", "operationId": "getPaymentMethodByIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "28949a61-f663-418f-8c5a-018da2e51f69" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "60d08247-03e3-47f0-9c08-98ac8523aeea" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "41169e96-4ca1-499d-b6ea-05eedba9ced6" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b2b918b2-687c-4c51-8823-3998aed03dfb" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "de37500c-9ba3-4e66-afc4-e354d3ca8caa" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "210e74c1-9bee-4831-9ca3-9c7c93a2449a" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "aac38a2a-8e72-43f1-944b-bf3182151d2f" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "cf4c636a-4a11-40e4-bd9b-2ac426d89a9e" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_c8e6904c-52ef-4345-a2ad-9f1bf8b28c3b" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "6bb2c127-6d5c-4f3b-b82b-17ac379a9164" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodDto" } ] } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v2/paymentmethod/{idOrAlias}": { "get": { "tags": [ "Payment Method" ], "summary": "Get a Payment Method by ID or Alias", "operationId": "getPaymentMethodByIdOrAliasV2", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b4a76dc8-bb8f-4464-90e7-e2531265639d" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "58e95270-d61e-4e22-b20c-87df5e2fe242" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b1d72a2c-c93c-4385-a877-a57d93d39a72" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e6771323-b289-4125-a946-2c0504192311" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6a847d03-56d4-408c-9e57-43a91ac24702" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b3a74886-ad10-4fc0-aa91-a2e071d82e07" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c8325bc2-c42a-4390-bfd1-681801694e45" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8124308f-edbd-4189-b598-8c2056f4b290" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_84826951-f79a-4502-b279-bd3e02f922de" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "41215489-41ab-4963-a7b1-fec35dd98549" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodV2Dto" } ] } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/paymentmethods": { "get": { "tags": [ "Payment Method" ], "summary": "Gets all the Payment Methods in a Store", "operationId": "searchPaymentMethods", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "78710b41-4956-46af-a646-1d3aa478bacf" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "c7458f8a-e776-48c1-8760-c1aa36f3fb0b" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f2b95ffe-72db-4fd3-867a-bcee497619a6" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f1fb8159-30cd-42d7-bbe7-f79308ddcb28" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "51ae67d5-dda4-4d9c-98fe-a16528331cfd" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1c7c655e-a232-4e4f-ab8a-fd691b67ec02" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "a43efe6d-9006-449e-889d-7ef9de8a3d80" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8de0307d-cedc-4e64-aaba-919f98654f96" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_9dd6ef24-3cf9-47bc-beaa-47bd48e55618" }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v2/paymentmethods": { "get": { "tags": [ "Payment Method" ], "summary": "Gets all the Payment Methods in a Store", "operationId": "searchPaymentMethodsV2", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b65d07e2-355a-4a70-bfd8-3ac2ce572ce1" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "257fd7aa-1698-41d2-b760-39cc062831f8" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4e9a2c1c-386e-4c35-80f7-1b00a4c47bcc" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "94583015-83e4-487c-a94d-b73aeb422426" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "1ca46c13-9ee5-4b4f-892d-c20a64120405" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0b831fc2-8aec-4406-8244-0e56c321d579" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c23bd9ea-2f01-4c6c-9024-76dae0b24943" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "57204fee-bb4d-4c5a-8d82-edb42d0be053" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_2e1b6f1a-b6fc-4f7e-93db-25bddaaf0528" }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodV2Dto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/products": { "get": { "tags": [ "Product" ], "summary": "Gets one or more Products by product reference", "operationId": "getProducts", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "908fa2e7-f60a-4f44-93ce-1f2796c71e45" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "ed180e11-9c0b-463c-adf4-4b5e730cc01e" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c4357de8-6b38-405e-8c5a-26e48e1262fe" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0b2c20d9-f319-4927-99fb-5f8a7a556125" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "93c342e4-a030-480d-8ab5-4ee6a1e20358" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "5c327ebb-050d-4b57-8ed8-cef69ce13ea4" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3e4056a0-a294-4270-abda-e3cef81d848e" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "66dfc510-eaf6-4bb3-a54c-6b52dbcec549" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_dfcc32ca-d8f1-483f-899e-e4a058c3cde3" }, { "name": "productReference", "in": "query", "description": "One or more product references of products / product variants to retrieve.", "schema": { "type": "string" }, "examples": { "A product": { "value": "659ef62c-6ffd-487b-84b3-6db832a034fc" }, "A product variant": { "value": "79ad174b-7f4b-4373-80c2-c715a1abefb7:3598b2dc-8b37-4acd-9744-48da76859857" } } }, { "name": "CalculateAdjustedPrices", "in": "query", "schema": { "type": "boolean" } }, { "name": "AdjustedPriceCalculationQuantity", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "AdjustedPriceCalculationDiscountCodes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "AdjustedPriceCalculationPriceCacheDuration", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "AdjustedPriceCalculationTempOrderCacheDuration", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ProductDto" } ] } } } } }, "400": { "description": "Bad Request" } } } }, "/umbraco/commerce/storefront/api/v1/shippingmethod/{idOrAlias}": { "get": { "tags": [ "Shipping Method" ], "summary": "Get a Shipping Method by ID or Alias", "operationId": "getShippingMethodByIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "fa5f54db-b58e-4f47-9011-1b82f10e1cc7" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "02fdae23-2323-470c-87bd-6142155359de" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "92947378-8fc4-4afb-88a1-8f605a3e59dc" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f43a5c66-e8d4-4e24-9648-a4f6f872846e" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6a74a3d9-524d-40c7-92cb-cc4c086b2dea" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "827d1d64-fc7f-42da-8d0a-e7e46131e847" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c0a5c496-7f2c-4609-9a77-b05d9b5ce8d9" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d5ea1bf0-f60d-496b-a953-45695a911cc6" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_c2ad270e-3a70-490a-8904-b26257e9ff06" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "0e2044a4-4b01-49a9-9f36-9540d7ebc003" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodDto" } ] } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v2/shippingmethod/{idOrAlias}": { "get": { "tags": [ "Shipping Method" ], "summary": "Get a Shipping Method by ID or Alias", "operationId": "getShippingMethodByIdOrAliasV2", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ba38c4d0-2aa6-4cff-90ce-a1459dc1fd4f" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "e4596e55-e0b4-49cb-a104-0dd7bcf950e4" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "4f1f3e81-b2f4-40d2-b430-7b82aedd4c1e" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "9fba5f9b-830b-4680-85ca-19c060fea192" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2163d5d6-824e-43a8-9fa8-45841a2161f9" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "12b1fe02-32f9-4d98-8701-c657c4ff4838" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ddc54907-e674-4b5c-8d51-c1d353082885" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8d2d03bd-93b9-4988-8afe-3c3be08e0a50" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_0fff1a7b-22cd-42ac-844a-74b633b5a9e7" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "cb31b5cf-6c25-4224-a62c-c7bc6b9435c4" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodV2Dto" } ] } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/shippingmethods": { "get": { "tags": [ "Shipping Method" ], "summary": "Gets all the Shipping Methods in a Store", "operationId": "searchShippingMethods", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "5dbfd403-975b-494e-8267-8b665547a094" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "74a69338-2b96-44e7-ad01-72240f45c807" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "f2300521-fb14-4d9a-b355-c6abbb2139f9" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "c9a399e5-3d94-426e-a39c-2e8a234ddab9" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "ee3211cd-d5e7-43c5-b543-4e6d743984f0" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "d6208b1e-6e0b-4caa-a90c-b286d503ebb1" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "0022e060-7d86-4f6c-b506-ce57567be4ed" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "43388489-9527-454d-b95a-190bf87b8ba3" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_a8ee3416-7279-4550-9fda-c969ff0b9fdf" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodDto" } ] } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/umbraco/commerce/storefront/api/v2/shippingmethods": { "get": { "tags": [ "Shipping Method" ], "summary": "Gets all the Shipping Methods in a Store", "operationId": "searchShippingMethodsV2", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Store", "in": "header", "description": "The ID or the alias of the store", "required": true, "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3702d96b-c719-424d-806c-d647b09fec71" }, "Entity Alias": { "value": "blendid" } } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "58c5e308-ef5c-4d1e-a9c0-6b6d0f74fa1a" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "38226835-7b09-4801-a4b3-8112997d87bf" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "2a579764-e260-4af8-9179-8838aaf56cb1" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "e79b7318-406a-4014-98f9-e8dd7ddb91b8" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "99708024-cc65-458e-a656-8d4e3cee29ce" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "b4ff1838-adb9-41c4-a9cc-afe26b8d3aaf" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "8d66536d-7875-4f8c-8224-b8a301adf2d9" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_0aae271c-9507-472a-958d-13728afd7ec5" }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } }, { "name": "filter", "in": "query", "description": "Filter the returned list of items", "schema": { "type": "string" }, "examples": { "Return all results": { "value": " " }, "Return items allowed in a given country": { "value": "allowedInCountry:GB" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodV2Dto" } ] } } } } }, "404": { "description": "Not Found" } } } }, "/umbraco/commerce/storefront/api/v1/store/{idOrAlias}": { "get": { "tags": [ "Store" ], "summary": "Gets a Store by ID or Alias", "operationId": "getStoreByIdOrAlias", "parameters": [ { "name": "Api-Key", "in": "header", "description": "API key specified through configuration to authorize access to the API.", "required": true, "schema": { "type": "string" } }, { "name": "Current-Order", "in": "header", "description": "The ID of the current order associated with the current session", "schema": { "type": "string" }, "example": "8a35fbc5-1ab1-49cc-af1c-6c638e0ce8de" }, { "name": "Billing-Country", "in": "header", "description": "The ID or alias of the session default billing country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "6ffe77e0-efd5-441a-9cad-dfc4f06a002b" }, "Entity Alias": { "value": "us" } } }, { "name": "Billing-Region", "in": "header", "description": "The ID or alias of the session default billing region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3f613d08-0676-433a-838e-deaaa19ad6cc" }, "Entity Alias": { "value": "az" } } }, { "name": "Shipping-Country", "in": "header", "description": "The ID or alias of the session default shipping country", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "777f5352-e709-4d8f-b1dd-6a934ed851fb" }, "Entity Alias": { "value": "us" } } }, { "name": "Shipping-Region", "in": "header", "description": "The ID or alias of the session default shipping region", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "120a143d-c9f1-4fdc-b270-557e12a6ef88" }, "Entity Alias": { "value": "az" } } }, { "name": "Tax-Class", "in": "header", "description": "The ID or alias of the session default tax class", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "97a1af8f-f460-4599-b3a0-1e389415e839" }, "Entity Alias": { "value": "or" } } }, { "name": "Currency", "in": "header", "description": "The ID or alias of the session currency", "schema": { "type": "string" }, "examples": { "Entity ID": { "value": "3daa83d3-a7b7-4999-9c6b-719f17e7c09c" }, "Entity Alias": { "value": "or" } } }, { "name": "Accept-Language", "in": "header", "description": "The ISO culture code of the current session culture", "schema": { "type": "string" }, "example": "en-US" }, { "name": "LanguageIsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Customer-Reference", "in": "header", "description": "The unique reference for the customer associated with the current session", "schema": { "type": "string" }, "example": "cust_8bb3d8b8-bf29-4a80-ac22-4ffb2159ab6e" }, { "name": "idOrAlias", "in": "path", "description": "The ID or the alias of the given resource", "required": true, "schema": { "oneOf": [ { "type": "string" } ] }, "examples": { "Entity ID": { "value": "ba94d8dd-2bce-49ed-9417-cbf2781df175" }, "Entity Alias": { "value": "alias" } } }, { "name": "fields", "in": "query", "description": "Limit the properties returned in the response", "schema": { "type": "string" }, "examples": { "Return all fields": { "value": " " }, "Return single field": { "value": "totalprice" }, "Return multiple fields": { "value": "orderlines,totalprice" }, "Return nested fields": { "value": "orderlines[sku,description]" } } }, { "name": "expand", "in": "query", "description": "Defines the properties that should be expanded in the response", "schema": { "type": "string" }, "examples": { "Expand none": { "value": " " }, "Expand prices": { "value": "$price" }, "Expand specific property": { "value": "currency" }, "Expand nested properties": { "value": "paymentmethod[taxclass]" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" } ] } } } }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "AddProductRequestDto": { "required": [ "productReference", "quantity" ], "type": "object", "properties": { "productReference": { "type": "string" }, "productVariantReference": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "bundleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdjustedAmountDto": { "type": "object", "properties": { "adjustments": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AmountAdjustmentDto" } ] }, "nullable": true }, "withoutAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "adjustment": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "value": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true } }, "additionalProperties": false }, "AdjustedPriceDto": { "type": "object", "properties": { "adjustments": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PriceAdjustmentDto" } ] }, "nullable": true }, "withoutAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "adjustment": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "value": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true } }, "additionalProperties": false }, "AdjustedPriceWithPreviousAdjustmentsDto": { "type": "object", "properties": { "adjustments": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PriceAdjustmentDto" } ] }, "nullable": true }, "withoutAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "adjustment": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "value": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "previousAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "withPreviousAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "totalAdjustment": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true } }, "additionalProperties": false }, "AdjustedProductPriceDto": { "type": "object", "properties": { "unitPrice": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "adjustedUnitPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true }, "adjustedLineTotalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true }, "effectiveUnitPrice": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "totalDiscountPerUnit": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "totalDiscountPercentage": { "type": "number", "format": "double", "nullable": true }, "discountCodes": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrderAppliedDiscountCodeDto" } ] }, "nullable": true }, "discounts": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DiscountReferenceDto" } ] }, "nullable": true } }, "additionalProperties": false }, "AllowedCountryDto": { "type": "object", "properties": { "country": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true } }, "additionalProperties": false }, "AmountAdjustmentDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "amount": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "originalAmount": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "metaData": { "type": "object", "additionalProperties": { }, "nullable": true } }, "additionalProperties": false }, "AmountDto": { "type": "object", "properties": { "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyReferenceDto" } ], "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "formatted": { "oneOf": [ { "$ref": "#/components/schemas/FormattedAmountDto" } ], "nullable": true } }, "additionalProperties": false }, "ApiContentModel": { "required": [ "contentType", "createDate", "id", "name", "properties", "route", "updateDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contentType": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "nullable": true } }, "name": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "updateDate": { "type": "string", "format": "date-time" }, "route": { "oneOf": [ { "$ref": "#/components/schemas/ApiContentRouteModel" } ] } }, "additionalProperties": false }, "ApiContentResponseModel": { "required": [ "contentType", "createDate", "cultures", "id", "name", "properties", "route", "updateDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contentType": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "nullable": true } }, "name": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "updateDate": { "type": "string", "format": "date-time" }, "route": { "oneOf": [ { "$ref": "#/components/schemas/ApiContentRouteModel" } ] }, "cultures": { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/ApiContentRouteModel" } ] } } }, "additionalProperties": false }, "ApiContentRouteModel": { "required": [ "path", "startItem" ], "type": "object", "properties": { "path": { "type": "string" }, "startItem": { "oneOf": [ { "$ref": "#/components/schemas/ApiContentStartItemModel" } ] } }, "additionalProperties": false }, "ApiContentStartItemModel": { "required": [ "id", "path" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "path": { "type": "string" } }, "additionalProperties": false }, "ApiElementModel": { "required": [ "contentType", "id", "properties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contentType": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "nullable": true } } }, "additionalProperties": false }, "AttributeCombinationDto": { "type": "object", "properties": { "name": { "oneOf": [ { "$ref": "#/components/schemas/AttributeNameDto" } ], "nullable": true }, "value": { "oneOf": [ { "$ref": "#/components/schemas/AttributeValueDto" } ], "nullable": true } }, "additionalProperties": false }, "AttributeNameDto": { "type": "object", "properties": { "alias": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttributeValueDto": { "type": "object", "properties": { "alias": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CheckoutConfirmDto": { "required": [ "orderNumber", "transactionInfo" ], "type": "object", "properties": { "orderNumber": { "type": "string" }, "transactionInfo": { "oneOf": [ { "$ref": "#/components/schemas/OrderTransactionInfoDto" } ] } }, "additionalProperties": false }, "CheckoutConfirmRequestDto": { "required": [ "amount", "paymentStatus", "transactionId" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "fee": { "type": "number", "format": "double", "nullable": true }, "transactionId": { "type": "string" }, "paymentStatus": { "$ref": "#/components/schemas/PaymentStatus" }, "metaData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CheckoutInitializedDto": { "required": [ "orderNumber", "paymentMethod" ], "type": "object", "properties": { "orderNumber": { "type": "string" }, "paymentMethod": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutPaymentMethodDto" } ] } }, "additionalProperties": false }, "CheckoutPaymentMethodDto": { "required": [ "settings", "urls" ], "type": "object", "properties": { "settings": { "type": "object", "additionalProperties": { "type": "string" } }, "metaDataDefinitions": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "urls": { "oneOf": [ { "$ref": "#/components/schemas/CheckoutPaymentMethodUrlsDto" } ] } }, "additionalProperties": false }, "CheckoutPaymentMethodUrlsDto": { "required": [ "callback", "cancel", "continue", "error" ], "type": "object", "properties": { "continue": { "type": "string" }, "cancel": { "type": "string" }, "error": { "type": "string" }, "callback": { "type": "string" } }, "additionalProperties": false }, "CheckoutTokenDto": { "required": [ "orderNumber", "token" ], "type": "object", "properties": { "token": { "type": "string" }, "orderNumber": { "type": "string" }, "payUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CountryDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "defaultCurrency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" }, { "$ref": "#/components/schemas/CurrencyNamedReferenceDto" }, { "$ref": "#/components/schemas/CurrencyReferenceDto" } ], "nullable": true }, "defaultPaymentMethod": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodBaseDto" }, { "$ref": "#/components/schemas/PaymentMethodDto" }, { "$ref": "#/components/schemas/PaymentMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodV2Dto" }, { "$ref": "#/components/schemas/PaymentMethodWithFeeDto" } ], "nullable": true }, "defaultShippingMethod": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodBaseDto" }, { "$ref": "#/components/schemas/ShippingMethodDto" }, { "$ref": "#/components/schemas/ShippingMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodV2Dto" }, { "$ref": "#/components/schemas/ShippingMethodWithRatesDto" } ], "nullable": true }, "regions": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RegionDto" }, { "$ref": "#/components/schemas/RegionNamedReferenceDto" }, { "$ref": "#/components/schemas/RegionReferenceDto" } ] }, "nullable": true } }, "additionalProperties": false }, "CountryNamedReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CountryReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" } }, "additionalProperties": false }, "CountryRegionTaxClassDto": { "type": "object", "properties": { "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "country": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true }, "region": { "oneOf": [ { "$ref": "#/components/schemas/RegionDto" }, { "$ref": "#/components/schemas/RegionNamedReferenceDto" }, { "$ref": "#/components/schemas/RegionReferenceDto" } ], "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateOrderRequestDto": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "currency": { "oneOf": [ { "type": "string" } ], "nullable": true }, "taxClass": { "oneOf": [ { "type": "string" } ], "nullable": true }, "customerReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrencyDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "culture": { "type": "string", "nullable": true }, "symbol": { "type": "string", "nullable": true }, "decimalPlaces": { "type": "integer", "format": "int32", "nullable": true }, "decimalSeparator": { "type": "string", "nullable": true }, "groupSeparator": { "type": "string", "nullable": true }, "formatTemplate": { "type": "string", "nullable": true }, "allowedCountries": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AllowedCountryDto" } ] }, "nullable": true } }, "additionalProperties": false }, "CurrencyNamedReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrencyReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" } }, "additionalProperties": false }, "DiscountDto": { "required": [ "alias", "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "type": { "$ref": "#/components/schemas/DiscountType" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DiscountNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DiscountReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "DiscountType": { "enum": [ "Automatic", "Code" ], "type": "string" }, "EventMessageTypeModel": { "enum": [ "Default", "Info", "Error", "Success", "Warning" ], "type": "string" }, "FormattedAmountDto": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FormattedPriceDto": { "type": "object", "properties": { "withoutTax": { "type": "string", "nullable": true }, "tax": { "type": "string", "nullable": true }, "withTax": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GiftCardReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" } }, "additionalProperties": false }, "HostedCheckoutMode": { "enum": [ "Framed", "Redirect" ], "type": "string" }, "NotificationHeaderModel": { "required": [ "category", "message", "type" ], "type": "object", "properties": { "message": { "type": "string" }, "category": { "type": "string" }, "type": { "$ref": "#/components/schemas/EventMessageTypeModel" } }, "additionalProperties": false }, "OrderAppliedDiscountCodeDto": { "type": "object", "properties": { "discount": { "oneOf": [ { "$ref": "#/components/schemas/DiscountDto" }, { "$ref": "#/components/schemas/DiscountNamedReferenceDto" }, { "$ref": "#/components/schemas/DiscountReferenceDto" } ], "nullable": true }, "code": { "type": "string", "nullable": true }, "isFulfilled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OrderCustomerInfoDto": { "type": "object", "properties": { "customerReference": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderNumber": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "cartNumber": { "type": "string", "nullable": true }, "languageIsoCode": { "type": "string", "nullable": true }, "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" }, { "$ref": "#/components/schemas/CurrencyNamedReferenceDto" }, { "$ref": "#/components/schemas/CurrencyReferenceDto" } ], "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "orderStatus": { "oneOf": [ { "$ref": "#/components/schemas/OrderStatusDto" }, { "$ref": "#/components/schemas/OrderStatusNamedReferenceDto" }, { "$ref": "#/components/schemas/OrderStatusReferenceDto" } ], "nullable": true }, "customerInfo": { "oneOf": [ { "$ref": "#/components/schemas/OrderCustomerInfoDto" } ], "nullable": true }, "paymentInfo": { "oneOf": [ { "$ref": "#/components/schemas/OrderPaymentInfoDto" } ], "nullable": true }, "shippingInfo": { "oneOf": [ { "$ref": "#/components/schemas/OrderShippingInfoDto" } ], "nullable": true }, "transactionInfo": { "oneOf": [ { "$ref": "#/components/schemas/OrderTransactionInfoDto" } ], "nullable": true }, "discountCodes": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrderAppliedDiscountCodeDto" } ] }, "nullable": true }, "discounts": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DiscountReferenceDto" } ] }, "nullable": true }, "giftCards": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/GiftCardReferenceDto" } ] }, "nullable": true }, "totalQuantity": { "type": "number", "format": "double", "nullable": true }, "subtotalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceWithPreviousAdjustmentsDto" } ], "nullable": true }, "totalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceWithPreviousAdjustmentsDto" } ], "nullable": true }, "transactionAmount": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedAmountDto" } ], "nullable": true }, "orderLines": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrderLineDto" } ] }, "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true }, "finalizedDate": { "type": "string", "format": "date-time", "nullable": true }, "isFinalized": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OrderLineDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "productReference": { "type": "string", "nullable": true }, "productVariantReference": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "bundleId": { "type": "string", "nullable": true }, "orderLines": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrderLineDto" } ] }, "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "attributes": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AttributeCombinationDto" } ] }, "nullable": true }, "basePrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true }, "unitPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "totalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceWithPreviousAdjustmentsDto" } ], "nullable": true } }, "additionalProperties": false }, "OrderPaymentInfoDto": { "type": "object", "properties": { "country": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true }, "region": { "oneOf": [ { "$ref": "#/components/schemas/RegionDto" }, { "$ref": "#/components/schemas/RegionNamedReferenceDto" }, { "$ref": "#/components/schemas/RegionReferenceDto" } ], "nullable": true }, "paymentMethod": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodBaseDto" }, { "$ref": "#/components/schemas/PaymentMethodDto" }, { "$ref": "#/components/schemas/PaymentMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodV2Dto" }, { "$ref": "#/components/schemas/PaymentMethodWithFeeDto" } ], "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "totalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true } }, "additionalProperties": false }, "OrderShippingInfoDto": { "type": "object", "properties": { "country": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true }, "region": { "oneOf": [ { "$ref": "#/components/schemas/RegionDto" }, { "$ref": "#/components/schemas/RegionNamedReferenceDto" }, { "$ref": "#/components/schemas/RegionReferenceDto" } ], "nullable": true }, "shippingMethod": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodBaseDto" }, { "$ref": "#/components/schemas/ShippingMethodDto" }, { "$ref": "#/components/schemas/ShippingMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodV2Dto" }, { "$ref": "#/components/schemas/ShippingMethodWithRatesDto" } ], "nullable": true }, "shippingOption": { "oneOf": [ { "$ref": "#/components/schemas/ShippingOptionDto" } ], "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "totalPrice": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedPriceDto" } ], "nullable": true } }, "additionalProperties": false }, "OrderStatusDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderStatusNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderStatusReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "OrderTransactionInfoDto": { "required": [ "paymentStatus" ], "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true }, "authorizedAmount": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "feeAmount": { "oneOf": [ { "$ref": "#/components/schemas/AmountDto" } ], "nullable": true }, "baseCurrencyExchangeRate": { "type": "number", "format": "double", "nullable": true }, "paymentStatus": { "$ref": "#/components/schemas/PaymentStatus" } }, "additionalProperties": false }, "PaymentMethodBaseDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "paymentProviderAlias": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "paymentProviderAlias": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "price": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true, "deprecated": true } }, "additionalProperties": false }, "PaymentMethodNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "PaymentMethodV2Dto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "paymentProviderAlias": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodWithFeeDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "paymentProviderAlias": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "fee": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true } }, "additionalProperties": false }, "PaymentStatus": { "enum": [ "Initialized", "Authorized", "Captured", "Cancelled", "Refunded", "PendingExternalSystem", "PartiallyRefunded", "Error" ], "type": "string" }, "PriceAdjustmentDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "price": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "originalPrice": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "metaData": { "type": "object", "additionalProperties": { }, "nullable": true } }, "additionalProperties": false }, "PriceDto": { "type": "object", "properties": { "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyReferenceDto" } ], "nullable": true }, "withoutTax": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "number", "format": "double", "nullable": true }, "withTax": { "type": "number", "format": "double", "nullable": true }, "formatted": { "oneOf": [ { "$ref": "#/components/schemas/FormattedPriceDto" } ], "nullable": true } }, "additionalProperties": false }, "ProductDto": { "required": [ "productReference", "sku" ], "type": "object", "properties": { "productReference": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string", "nullable": true }, "productVariantReference": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "price": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true }, "priceWithAdjustments": { "oneOf": [ { "$ref": "#/components/schemas/AdjustedProductPriceDto" } ], "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "attributes": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AttributeCombinationDto" } ] }, "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "isGiftCard": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ProductVariantItemDto": { "type": "object", "properties": { "content": { "oneOf": [ { "$ref": "#/components/schemas/ApiContentModel" }, { "$ref": "#/components/schemas/ApiContentResponseModel" }, { "$ref": "#/components/schemas/ApiElementModel" } ], "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "isDefault": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "RegionDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "country": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true }, "defaultPaymentMethod": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodBaseDto" }, { "$ref": "#/components/schemas/PaymentMethodDto" }, { "$ref": "#/components/schemas/PaymentMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodReferenceDto" }, { "$ref": "#/components/schemas/PaymentMethodV2Dto" }, { "$ref": "#/components/schemas/PaymentMethodWithFeeDto" } ], "nullable": true }, "defaultShippingMethod": { "oneOf": [ { "$ref": "#/components/schemas/ShippingMethodBaseDto" }, { "$ref": "#/components/schemas/ShippingMethodDto" }, { "$ref": "#/components/schemas/ShippingMethodNamedReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodReferenceDto" }, { "$ref": "#/components/schemas/ShippingMethodV2Dto" }, { "$ref": "#/components/schemas/ShippingMethodWithRatesDto" } ], "nullable": true } }, "additionalProperties": false }, "RegionNamedReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegionReferenceDto": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" } }, "additionalProperties": false }, "ShippingMethodBaseDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShippingMethodDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "price": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true, "deprecated": true } }, "additionalProperties": false }, "ShippingMethodNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShippingMethodReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "ShippingMethodV2Dto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShippingMethodWithRatesDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "sku": { "type": "string", "nullable": true }, "taxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "rates": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShippingRateDto" } ] }, "nullable": true } }, "additionalProperties": false }, "ShippingOptionDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShippingRateDto": { "type": "object", "properties": { "option": { "oneOf": [ { "$ref": "#/components/schemas/ShippingOptionDto" } ], "nullable": true }, "packageId": { "type": "string", "format": "uuid", "nullable": true }, "value": { "oneOf": [ { "$ref": "#/components/schemas/PriceDto" } ], "nullable": true } }, "additionalProperties": false }, "StoreDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "defaultCountry": { "oneOf": [ { "$ref": "#/components/schemas/CountryDto" }, { "$ref": "#/components/schemas/CountryNamedReferenceDto" }, { "$ref": "#/components/schemas/CountryReferenceDto" } ], "nullable": true }, "defaultTaxClass": { "oneOf": [ { "$ref": "#/components/schemas/TaxClassDto" }, { "$ref": "#/components/schemas/TaxClassNamedReferenceDto" }, { "$ref": "#/components/schemas/TaxClassReferenceDto" } ], "nullable": true }, "baseCurrency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyDto" }, { "$ref": "#/components/schemas/CurrencyNamedReferenceDto" }, { "$ref": "#/components/schemas/CurrencyReferenceDto" } ], "nullable": true }, "pricesIncludeTax": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "StoreNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StoreReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "TaxClassDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true }, "store": { "oneOf": [ { "$ref": "#/components/schemas/StoreDto" }, { "$ref": "#/components/schemas/StoreNamedReferenceDto" }, { "$ref": "#/components/schemas/StoreReferenceDto" } ], "nullable": true }, "defaultTaxRate": { "type": "number", "format": "double", "nullable": true }, "defaultTaxCode": { "type": "string", "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "type": "string", "nullable": true }, "countryRegionTaxClasses": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CountryRegionTaxClassDto" } ] }, "nullable": true } }, "additionalProperties": false }, "TaxClassNamedReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxClassReferenceDto": { "required": [ "alias", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" } }, "additionalProperties": false }, "UpdateAddressRequestDto": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "country": { "oneOf": [ { "type": "string" } ], "nullable": true }, "region": { "oneOf": [ { "type": "string" } ], "nullable": true } }, "additionalProperties": false }, "UpdateContactRequestDto": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCustomerRequestDto": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "taxCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateOrderLineRequestDto": { "type": "object", "properties": { "quantityIncrement": { "type": "number", "format": "double", "nullable": true }, "quantityDecrement": { "type": "number", "format": "double", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "taxClass": { "oneOf": [ { "type": "string" } ], "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateOrderLineWithIdRequestDto": { "required": [ "id" ], "type": "object", "properties": { "quantityIncrement": { "type": "number", "format": "double", "nullable": true }, "quantityDecrement": { "type": "number", "format": "double", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "taxClass": { "oneOf": [ { "type": "string" } ], "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "UpdateOrderRequestDto": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "currency": { "oneOf": [ { "type": "string" } ], "nullable": true }, "taxClass": { "oneOf": [ { "type": "string" } ], "nullable": true }, "customerReference": { "type": "string", "nullable": true }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/UpdateCustomerRequestDto" } ], "nullable": true }, "billingAddress": { "oneOf": [ { "$ref": "#/components/schemas/UpdateAddressRequestDto" } ], "nullable": true }, "shippingAddress": { "oneOf": [ { "$ref": "#/components/schemas/UpdateShippingAddressRequestDto" } ], "nullable": true }, "shippingMethod": { "oneOf": [ { "type": "string" } ], "nullable": true }, "shippingOption": { "type": "string", "nullable": true }, "paymentMethod": { "oneOf": [ { "type": "string" } ], "nullable": true }, "redeem": { "type": "array", "items": { "type": "string" }, "nullable": true }, "unredeem": { "type": "array", "items": { "type": "string" }, "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateShippingAddressRequestDto": { "required": [ "sameAsBilling" ], "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "country": { "oneOf": [ { "type": "string" } ], "nullable": true }, "region": { "oneOf": [ { "type": "string" } ], "nullable": true }, "contact": { "oneOf": [ { "$ref": "#/components/schemas/UpdateContactRequestDto" } ], "nullable": true }, "sameAsBilling": { "type": "boolean" } }, "additionalProperties": false } }, "securitySchemes": { "Backoffice User": { "type": "oauth2", "description": "Umbraco Authentication", "flows": { "authorizationCode": { "authorizationUrl": "/umbraco/management/api/v1/security/back-office/authorize", "tokenUrl": "/umbraco/management/api/v1/security/back-office/token", "scopes": { } } } } } } }