--- title: Get Price by Zone slug: api-documentation/oY5c-get-price-by-zone docTags: createdAt: 2026-08-27T17:06:08.900Z --- { "id": "Gj_9DQoc5m35j8G4J7biq", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone}" } ], "name": "Get Price by Zone", "description": "

This endpoint returns pricing for an asset/stock keeping unit (SKU) by asset id and zone.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "assetId", "type": "string", "description": "Unique identifier for the asset to be looked up." }, { "kind": "required", "name": "zone", "type": "string", "description": "This is the zone for which pricing is required." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "AnonymousAuth", "name": "AnonymousAuth", "kind": "optional", "type": "http", "description": "This is the most basic authentication. The minimum requirement for access is a token representing the user as an anonymous client.", "scheme": "bearer" }, { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-relevant prices returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The prices held for an asset: its MSRP, list and sale prices.

", "customType": "Pricing", "schema": [ { "name": "assetId", "kind": "required", "type": "string", "description": "" }, { "name": "listPrices", "kind": "optional", "type": "object", "description": "A price entry on an asset's MSRP or list price set.", "modelRef": "#/components/schemas/PricingItem", "customType": "PricingItem[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "PriceItem", "description": "", "modelRef": "#/components/schemas/PriceItem", "schema": [ { "name": "zone", "kind": "required", "type": "string", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "", "minimum": 0, "exclusiveMinimum": true }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "example": "USD", "pattern": "^[A-Z]{3}$" } ] } ] }, { "name": "msrpPrices", "kind": "optional", "type": "object", "description": "A price entry on an asset's MSRP or list price set.", "modelRef": "#/components/schemas/PricingItem", "customType": "PricingItem[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "PriceItem", "description": "", "modelRef": "#/components/schemas/PriceItem", "schema": [ { "name": "zone", "kind": "required", "type": "string", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "", "minimum": 0, "exclusiveMinimum": true }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "example": "USD", "pattern": "^[A-Z]{3}$" } ] } ] }, { "name": "salePrices", "kind": "optional", "type": "object", "description": "

A sale price for a zone, effective between its activation and deactivation dates, optionally qualified by a tag.

", "modelRef": "#/components/schemas/SalePricingItem", "customType": "SalePricingItem[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "PriceItem", "description": "", "modelRef": "#/components/schemas/PriceItem", "schema": [ { "name": "zone", "kind": "required", "type": "string", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "", "minimum": 0, "exclusiveMinimum": true }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "example": "USD", "pattern": "^[A-Z]{3}$" } ] }, { "name": "object", "description": "", "schema": [ { "name": "activationDate", "kind": "required", "type": "string", "description": "", "format": "date" }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "example": "USD", "pattern": "^[A-Z]{3}$" }, { "name": "deactivationDate", "kind": "required", "type": "string", "description": "", "format": "date" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "tag", "kind": "optional", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" } ] } ] } ], "modelRef": "#/components/schemas/Pricing", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload returned when a request fails validation, identifying the offending input by name and code.

", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "frcrB3FaGY1UDuozi8cyO", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "lgzCY0PBKtTOHBTPXI-8p", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "KETD02mPLn_Y5CV-lSGeP", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "m7ULHvbXLGKauI2Lgo1ga", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/pricing/{assetId}/zone/{zone}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "frcrB3FaGY1UDuozi8cyO" }, "results": { "languages": [ { "id": "FjDKnQNm4krU8Rn3k5vSb", "language": "200", "code": "// Success-relevant prices returned.\n{\n \"assetId\": \"\",\n \"listPrices\": {},\n \"msrpPrices\": {},\n \"salePrices\": {}\n}" }, { "id": "4ugzVpPC3zdXI-FSO1IZI", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "MlqwwZ5g8hsRyIj_XXTwb", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "_OuQhkXYBks_WEgLiU-PW", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "1hYc-iLBtkzDMln1rla4Q", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "FjDKnQNm4krU8Rn3k5vSb" } }, "children": [ { "text": "" } ] }