{ "info": { "name": "Ecomiq Storefront API 1.0.0", "description": "Public commerce API used by @ecomiq/storefront for catalog, customer accounts, carts, checkout, and orders.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://storefront.ecomiq.pe/api", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" }, { "key": "storeDomain", "value": "my-store", "type": "string" } ], "item": [ { "name": "Analytics & Operations", "item": [ { "name": "Track commerce analytics events", "description": "Operation ID: TrackAnalyticsEvents", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: TrackAnalyticsEvents\n\nRecords commerce events from the storefront — product views, add to cart, checkout steps — that feed the merchant's analytics.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/analytics/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "analytics", "events" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"type\": \"example\",\n \"visitorId\": \"7204558912004325301\",\n \"sessionId\": \"7204558912004325301\",\n \"eventId\": \"2f40d7e4-3d9c-4ab2-b04e-7a6a132db821\",\n \"occurredAt\": \"2026-08-01T15:30:00Z\",\n \"productKey\": \"example\",\n \"productId\": \"7204558912004325301\",\n \"cartId\": \"7204558912004325301\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get analytics tracker", "description": "Operation ID: GetAnalyticsTrackerV1", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetAnalyticsTrackerV1\n\nGet analytics tracker. A successful request returns HTTP 200 with the documented response body.", "header": [], "url": { "raw": "{{baseUrl}}/v1/analytics/tracker/v1.js", "host": [ "{{baseUrl}}" ], "path": [ "v1", "analytics", "tracker", "v1.js" ], "query": [], "variable": [] } } } ] }, { "name": "Content & Storefront", "item": [ { "name": "Unlock private store", "description": "Operation ID: UnlockStoreAccess", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: UnlockStoreAccess\n\nGrants access to a storefront that is not public yet. Used for stores behind a password while they are being prepared.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/access/unlock", "host": [ "{{baseUrl}}" ], "path": [ "v1", "access", "unlock" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List published articles", "description": "Operation ID: getV1Articles", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Articles\n\nList published articles. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/articles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "articles" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "folder", "value": "example", "disabled": true }, { "key": "tag", "value": "example", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "Get a published article", "description": "Operation ID: getV1ArticlesSlug", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1ArticlesSlug\n\nGet a published article. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/articles/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "articles", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } }, { "name": "Get the article RSS feed", "description": "Operation ID: getV1ArticlesFeed", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1ArticlesFeed\n\nGet the article RSS feed. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/articles/feed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "articles", "feed" ], "query": [], "variable": [] } } }, { "name": "List brands", "description": "Operation ID: getV1Brands", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Brands\n\nLists the brands present in the published catalog. Useful to build a brand filter outside the facets of a search.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/brands", "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sort", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "List categories", "description": "Operation ID: getV1Categories", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Categories\n\nLists the categories of the published catalog, in the hierarchy the merchant defined.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "categories" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sort", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "List collections", "description": "Operation ID: getV1Collections", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Collections\n\nLists the published collections with their public metadata.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/collections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "collections" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sort", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "Get collection by slug", "description": "Operation ID: getV1CollectionsSlug", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1CollectionsSlug\n\nReturns one published collection by slug, with its name, description and media.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/collections/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "collections", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } }, { "name": "List active menus", "description": "Operation ID: getV1Menus", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Menus\n\nLists the active menus. They also arrive inside the store settings snapshot.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/menus", "host": [ "{{baseUrl}}" ], "path": [ "v1", "menus" ], "query": [], "variable": [] } } }, { "name": "Get active menu by key", "description": "Operation ID: getV1MenusKey", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1MenusKey\n\nReturns one menu by its key, with its items in order.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/menus/{key}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "menus", ":key" ], "query": [], "variable": [ { "key": "key", "value": "example" } ] } } }, { "name": "List published pages", "description": "Operation ID: getV1Pages", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Pages\n\nLists the published CMS pages. They also arrive inside the store settings snapshot.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/pages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pages" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "Get page by slug", "description": "Operation ID: getV1PagesSlug", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1PagesSlug\n\nReturns a published page by its slug, with its sections and blocks.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/pages/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pages", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } }, { "name": "List payment methods", "description": "Operation ID: ListStorefrontPaymentMethods", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: ListStorefrontPaymentMethods\n\nList payment methods. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "methods" ], "query": [], "variable": [] } } }, { "name": "Get product search suggestions", "description": "Operation ID: getV1SearchAutocomplete", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1SearchAutocomplete\n\nReturns product suggestions while the shopper types a search query.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/search/autocomplete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "search", "autocomplete" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": false }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": false } ], "variable": [] } } }, { "name": "List sellers", "description": "Operation ID: getV1Sellers", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Sellers\n\nLists the active sellers of a marketplace store for the public seller directory. Returns 404 when the store is not a marketplace.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers" ], "query": [], "variable": [] } } }, { "name": "Get seller by slug", "description": "Operation ID: getV1SellersSlug", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1SellersSlug\n\nReturns the public profile of a marketplace seller: identity, rating and public policies. Returns 404 when the store is not a marketplace or the seller does not exist.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } }, { "name": "List store settings", "description": "Operation ID: GetStoreSettings", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetStoreSettings\n\nReturns everything the storefront needs to render in a single snapshot: store, checkout, theme, features, CMS settings, pages and menus. Fetch it once per request instead of calling the individual settings endpoints.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "settings" ], "query": [], "variable": [] } } }, { "name": "Get site settings", "description": "Operation ID: getV1SiteSettings", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1SiteSettings\n\nReturns the CMS settings on their own. Prefer the full store settings snapshot unless you only need this slice.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/site-settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "site-settings" ], "query": [], "variable": [] } } }, { "name": "List public store locations", "description": "Operation ID: getV1StoreLocations", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1StoreLocations\n\nLists active physical store locations by cursor, with optional name or city search.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/store-locations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "store-locations" ], "query": [ { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true }, { "key": "cursor", "value": "example", "description": "Opaque cursor from the previous response. Omit it on the first page.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sortBy", "value": "example", "description": "Field to sort by. Accepted values depend on the resource.", "disabled": true }, { "key": "sortDirection", "value": "asc", "description": "Sort direction: `asc` or `desc`.", "disabled": true } ], "variable": [] } } }, { "name": "Get public store location", "description": "Operation ID: getV1StoreLocationsId", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1StoreLocationsId\n\nReturns one active physical store location with its public address and fulfillment details.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/store-locations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "store-locations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Resolve route", "description": "Operation ID: GetStorefrontRoute", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetStorefrontRoute\n\nReturns the active storefront slug for a hostname.", "header": [], "url": { "raw": "{{baseUrl}}/v1/storefront-routes/{hostname}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storefront-routes", ":hostname" ], "query": [], "variable": [ { "key": "hostname", "value": "Example resource" } ] } } } ] }, { "name": "Customers", "item": [ { "name": "Get customer", "description": "Operation ID: GetCustomer", "request": { "method": "GET", "description": "Operation ID: GetCustomer\n\nGet customer. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer" ], "query": [], "variable": [] } } }, { "name": "Update customer", "description": "Operation ID: UpdateCustomer", "request": { "method": "PATCH", "description": "Operation ID: UpdateCustomer\n\nUpdate customer. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"phone\": \"+51987654321\",\n \"identificationNumber\": \"example\",\n \"identificationType\": \"example\",\n \"entityName\": \"Comercial Lima SAC\",\n \"entityIdentificationNumber\": \"example\",\n \"gender\": \"male\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a customer address", "description": "Operation ID: CreateCustomerAddress", "request": { "method": "POST", "description": "Operation ID: CreateCustomerAddress\n\nAdds an address to the authenticated customer's profile.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "addresses" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"addressKey\": \"example\",\n \"countryIsoCode\": \"example_code\",\n \"addressLine\": \"example\",\n \"addressNumber\": \"example\",\n \"department\": \"example\",\n \"province\": \"example\",\n \"district\": \"example\",\n \"phone\": \"+51987654321\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List customer addresses", "description": "Operation ID: ListCustomerAddresses", "request": { "method": "GET", "description": "Operation ID: ListCustomerAddresses\n\nList customer addresses. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "addresses" ], "query": [], "variable": [] } } }, { "name": "Delete customer address", "description": "Operation ID: DeleteCustomerAddress", "request": { "method": "DELETE", "description": "Operation ID: DeleteCustomerAddress\n\nDelete customer address. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "addresses", ":addressId" ], "query": [], "variable": [ { "key": "addressId", "value": "7204558912004325301" } ] } } }, { "name": "Update customer address", "description": "Operation ID: UpdateCustomerAddress", "request": { "method": "PUT", "description": "Operation ID: UpdateCustomerAddress\n\nUpdate customer address. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "addresses", ":addressId" ], "query": [], "variable": [ { "key": "addressId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"addressKey\": \"example\",\n \"countryIsoCode\": \"example_code\",\n \"addressLine\": \"example\",\n \"addressNumber\": \"example\",\n \"department\": \"example\",\n \"province\": \"example\",\n \"district\": \"example\",\n \"phone\": \"+51987654321\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set default address", "description": "Operation ID: SetCustomerDefaultAddress", "request": { "method": "POST", "description": "Operation ID: SetCustomerDefaultAddress\n\nMarks one of the customer's saved addresses as the default. The previous default is cleared in the same operation.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/addresses/{addressId}/default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "addresses", ":addressId", "default" ], "query": [], "variable": [ { "key": "addressId", "value": "7204558912004325301" } ] } } }, { "name": "Log in customer", "description": "Operation ID: LoginCustomer", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: LoginCustomer\n\nExchanges the customer's credentials for access tokens. The storefront normally keeps the session in an HttpOnly cookie rather than handing the token to page scripts.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/login", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "login" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\",\n \"password\": \"Example-Password-2026!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request password recovery", "description": "Operation ID: RecoveryCustomerPassword", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: RecoveryCustomerPassword\n\nSends the customer a link to set a new password. Responds 200 whether or not the address belongs to an account, so the endpoint cannot be used to discover which emails are registered.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/recovery-password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "recovery-password" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Register customer", "description": "Operation ID: RegisterCustomer", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: RegisterCustomer\n\nRegisters a shopper using the store's configured identity scope and creates or links the customer record for this store.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/register", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "register" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"countryIsoCode\": \"example_code\",\n \"password\": \"Example-Password-2026!\",\n \"phone\": \"+51987654321\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Fulfillment & Shipping", "item": [ { "name": "List areas", "description": "Operation ID: getV1GeoAreas", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoAreas\n\nLists geographic areas, optionally filtered by country, level, parent, source and text.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/areas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "areas" ], "query": [ { "key": "countryCode", "value": "PE", "description": "ISO 3166-1 alpha-2 country code, for example `PE`.", "disabled": true }, { "key": "type", "value": "level1", "description": "Only this type.", "disabled": true }, { "key": "parentId", "value": "7204558912004325301", "description": "Identifier of the parent.", "disabled": true }, { "key": "parentCode", "value": "example_code", "disabled": true }, { "key": "source", "value": "example", "description": "Source of the data.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "Get area", "description": "Operation ID: getV1GeoAreasId", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoAreasId\n\nReturns one geographic area by ID.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/areas/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "areas", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List countries", "description": "Operation ID: getV1GeoCountries", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoCountries\n\nLists countries from the geographic catalog, with optional text search and result limit.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "countries" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "List departments", "description": "Operation ID: getV1GeoDepartments", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoDepartments\n\nLists departments for a country, with optional source, text search and result limit.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/departments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "departments" ], "query": [ { "key": "countryCode", "value": "PE", "description": "ISO 3166-1 alpha-2 country code, for example `PE`.", "disabled": true }, { "key": "source", "value": "example", "description": "Source of the data.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "List districts", "description": "Operation ID: getV1GeoDistricts", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoDistricts\n\nLists districts for a province, selected by its ID or source-specific code.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/districts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "districts" ], "query": [ { "key": "countryCode", "value": "PE", "description": "ISO 3166-1 alpha-2 country code, for example `PE`.", "disabled": true }, { "key": "provinceId", "value": "7204558912004325301", "disabled": true }, { "key": "provinceCode", "value": "example_code", "disabled": true }, { "key": "source", "value": "example", "description": "Source of the data.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "List provinces", "description": "Operation ID: getV1GeoProvinces", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoProvinces\n\nLists provinces for a department, selected by its ID or source-specific code.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/provinces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "provinces" ], "query": [ { "key": "countryCode", "value": "PE", "description": "ISO 3166-1 alpha-2 country code, for example `PE`.", "disabled": true }, { "key": "departmentId", "value": "7204558912004325301", "disabled": true }, { "key": "departmentCode", "value": "example_code", "disabled": true }, { "key": "source", "value": "example", "description": "Source of the data.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [] } } }, { "name": "Resolve area by source code", "description": "Operation ID: getV1GeoResolve", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1GeoResolve\n\nResolves a source-specific geographic code to its canonical area.", "header": [], "url": { "raw": "{{baseUrl}}/v1/geo/resolve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geo", "resolve" ], "query": [ { "key": "countryCode", "value": "PE", "description": "ISO 3166-1 alpha-2 country code, for example `PE`.", "disabled": false }, { "key": "source", "value": "example", "description": "Source of the data.", "disabled": false }, { "key": "code", "value": "example_code", "disabled": false } ], "variable": [] } } }, { "name": "Get public order tracking", "description": "Operation ID: getV1TrackingTrackingNumber", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1TrackingTrackingNumber\n\nReturns the public shipping status for a tracking number issued by this store.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/tracking/{trackingNumber}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tracking", ":trackingNumber" ], "query": [], "variable": [ { "key": "trackingNumber", "value": "example" } ] } } } ] }, { "name": "Orders & Checkout", "item": [ { "name": "Create cart", "description": "Operation ID: CreateCart", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: CreateCart\n\nCreate cart. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"PEN\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get cart", "description": "Operation ID: GetStorefrontCart", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetStorefrontCart\n\nGet cart. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] } } }, { "name": "Update cart addresses", "description": "Operation ID: UpdateCartAddresses", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "description": "Operation ID: UpdateCartAddresses\n\nUpdate cart addresses. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "addresses" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingAddress\": {\n \"name\": \"Example resource\",\n \"address1\": \"example\",\n \"city\": \"example\",\n \"countryCode\": \"PE\",\n \"company\": \"example\",\n \"address2\": \"example\",\n \"province\": \"example\",\n \"postalCode\": \"example_code\",\n \"district\": \"example\",\n \"phone\": \"+51987654321\",\n \"latitude\": 1,\n \"longitude\": 1\n },\n \"billingAddress\": {\n \"name\": \"Example resource\",\n \"address1\": \"example\",\n \"city\": \"example\",\n \"countryCode\": \"PE\",\n \"company\": \"example\",\n \"address2\": \"example\",\n \"province\": \"example\",\n \"postalCode\": \"example_code\",\n \"district\": \"example\",\n \"phone\": \"+51987654321\",\n \"latitude\": 1,\n \"longitude\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update cart buyer", "description": "Operation ID: UpdateCartBuyer", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "description": "Operation ID: UpdateCartBuyer\n\nUpdate cart buyer. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/buyer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "buyer" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\",\n \"phone\": \"+51987654321\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"identificationType\": \"example\",\n \"identificationNumber\": \"example\",\n \"entityTaxId\": \"7204558912004325301\",\n \"entityName\": \"Comercial Lima SAC\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Checkout cart", "description": "Operation ID: CheckoutCart", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: CheckoutCart\n\nCreates the order group for the cart and returns its order IDs, payment state, and completed cart. A multi-seller cart can produce multiple orders.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/checkout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "checkout" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"paymentMethodCode\": \"example_code\",\n \"externalRef\": \"example\",\n \"receiptUrl\": \"https://example.com/resource\",\n \"campaignId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get cart checkout options", "description": "Operation ID: GetStorefrontCartCheckout", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetStorefrontCartCheckout\n\nReturns the active cart, enabled checkout payment methods, and available order bumps.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/checkout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "checkout" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] } } }, { "name": "Add item to cart", "description": "Operation ID: AddItemToCart", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: AddItemToCart\n\nAdd item to cart. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "items" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"variantId\": \"7204558912004325377\",\n \"quantity\": 2\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove item from cart", "description": "Operation ID: RemoveItemFromCart", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "description": "Operation ID: RemoveItemFromCart\n\nRemove item from cart. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/items/{cartItemId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "items", ":cartItemId" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." }, { "key": "cartItemId", "value": "7204558912004325301" } ] } } }, { "name": "Update cart item quantity", "description": "Operation ID: UpdateCartItemQuantity", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "description": "Operation ID: UpdateCartItemQuantity\n\nUpdate cart item quantity. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/items/{cartItemId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "items", ":cartItemId" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." }, { "key": "cartItemId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get cart order group", "description": "Operation ID: GetStorefrontCartOrder", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetStorefrontCartOrder\n\nReturns the orders a completed cart produced. A cart with items from several sellers becomes several orders under one group.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/order", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "order" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] } } }, { "name": "Upload cart payment receipt", "description": "Operation ID: UploadCartPaymentReceipt", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: UploadCartPaymentReceipt\n\nUpload cart payment receipt. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/payment-receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "payment-receipt" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "./comprobante-pago.pdf" } ] } } }, { "name": "Add promotion code", "description": "Operation ID: AddPromotionCode", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: AddPromotionCode\n\nAdd promotion code. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/promotion-codes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "promotion-codes" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"example_code\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove promotion code", "description": "Operation ID: RemovePromotionCode", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "description": "Operation ID: RemovePromotionCode\n\nRemove promotion code. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/promotion-codes/{code}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "promotion-codes", ":code" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." }, { "key": "code", "value": "example_code" } ] } } }, { "name": "Clear cart shipping method", "description": "Operation ID: ClearCartShippingMethod", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "description": "Operation ID: ClearCartShippingMethod\n\nClear cart shipping method. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/shipping-method", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "shipping-method" ], "query": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller.", "disabled": true }, { "key": "shippingProfileId", "value": "7204558912004325301", "description": "Identifier of the shipping profile.", "disabled": true } ], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] } } }, { "name": "Set cart shipping method", "description": "Operation ID: SetCartShippingMethod", "request": { "method": "PUT", "auth": { "type": "noauth" }, "description": "Operation ID: SetCartShippingMethod\n\nSet cart shipping method. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/shipping-method", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "shipping-method" ], "query": [], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] }, "body": { "mode": "raw", "raw": "{\n \"sellerId\": \"7204558912004325301\",\n \"shippingProfileId\": \"7204558912004325301\",\n \"shippingMethodId\": \"7204558912004325301\",\n \"rateId\": \"7204558912004325301\",\n \"locationId\": \"7204558912004325301\",\n \"pickupPointId\": \"7204558912004325301\",\n \"scheduledDate\": \"2026-08-01\",\n \"scheduledTime\": \"09:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List cart shipping options", "description": "Operation ID: ListCartShippingOptions", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: ListCartShippingOptions\n\nList cart shipping options. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/shipping-options", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "shipping-options" ], "query": [ { "key": "postalCode", "value": "example_code", "disabled": true }, { "key": "scheduledDate", "value": "2026-08-01", "disabled": true }, { "key": "scheduledTime", "value": "09:00:00Z", "disabled": true } ], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." } ] } } }, { "name": "List shipping slots", "description": "Operation ID: GetCartShippingOptionSlots", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetCartShippingOptionSlots\n\nList shipping slots. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartToken}/shipping-options/{rateId}/slots", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartToken", "shipping-options", ":rateId", "slots" ], "query": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller.", "disabled": true }, { "key": "shippingProfileId", "value": "7204558912004325301", "description": "Identifier of the shipping profile.", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "pickupPointId", "value": "7204558912004325301", "disabled": true }, { "key": "serviceCode", "value": "example_code", "disabled": true }, { "key": "date", "value": "2026-08-01", "disabled": false } ], "variable": [ { "key": "cartToken", "value": "replace_with_the_issued_token", "description": "Opaque token identifying the cart." }, { "key": "rateId", "value": "7204558912004325301" } ] } } }, { "name": "Get pickup options for checkout", "description": "Operation ID: GetPickupOptions", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetPickupOptions\n\nReturns the pickup points the shopper can collect from, as an alternative to delivery.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/shipping/pickup-options", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", "shipping", "pickup-options" ], "query": [ { "key": "shippingMethodId", "value": "7204558912004325301", "disabled": false } ], "variable": [] } } }, { "name": "Get delivery or pickup slots", "description": "Operation ID: GetShippingSlots", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetShippingSlots\n\nReturns the available time slots for a scheduled delivery or pickup method on the requested date.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/shipping/slots", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", "shipping", "slots" ], "query": [ { "key": "shippingMethodId", "value": "7204558912004325301", "disabled": false }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "pickupPointId", "value": "7204558912004325301", "disabled": true }, { "key": "postalCode", "value": "example_code", "disabled": true }, { "key": "latitude", "value": "1", "disabled": true }, { "key": "longitude", "value": "1", "disabled": true }, { "key": "date", "value": "2026-08-01", "disabled": false } ], "variable": [] } } }, { "name": "List customer orders", "description": "Operation ID: ListCustomerOrders", "request": { "method": "GET", "description": "Operation ID: ListCustomerOrders\n\nPaginated customer order history with items, shipping address and payment totals", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "orders" ], "query": [ { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true }, { "key": "cursor", "value": "example", "description": "Opaque cursor from the previous response. Omit it on the first page.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sortBy", "value": "example", "description": "Field to sort by. Accepted values depend on the resource.", "disabled": true }, { "key": "sortDirection", "value": "asc", "description": "Sort direction: `asc` or `desc`.", "disabled": true } ], "variable": [] } } }, { "name": "Get customer order", "description": "Operation ID: GetCustomerOrder", "request": { "method": "GET", "description": "Operation ID: GetCustomerOrder\n\nCustomer order detail with items, shipping, payments and status timeline", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/orders/{orderId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "orders", ":orderId" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Get order status", "description": "Operation ID: GetCustomerOrderStatus", "request": { "method": "GET", "description": "Operation ID: GetCustomerOrderStatus\n\nReturns the current status of one of the customer's orders, for an order tracking page.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/orders/{orderId}/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "orders", ":orderId", "status" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Get orders by group", "description": "Operation ID: GetCustomerOrderGroup", "request": { "method": "GET", "description": "Operation ID: GetCustomerOrderGroup\n\nReturns the orders of one group for the signed-in customer. A purchase split across sellers produces several orders under the same group.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false }, { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customer/orders/group/{orderGroup}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customer", "orders", "group", ":orderGroup" ], "query": [], "variable": [ { "key": "orderGroup", "value": "example" } ] } } }, { "name": "Get shared order draft", "description": "Operation ID: GetOrderDraftShare", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetOrderDraftShare\n\nGet shared order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/share/{shareToken}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", "share", ":shareToken" ], "query": [], "variable": [ { "key": "shareToken", "value": "replace_with_the_issued_token" } ] } } }, { "name": "Get order review context", "description": "Operation ID: GetOrderReviewContext", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: GetOrderReviewContext\n\nGet order review context. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/review-context/{reviewToken}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "review-context", ":reviewToken" ], "query": [], "variable": [ { "key": "reviewToken", "value": "replace_with_the_issued_token" } ] } } } ] }, { "name": "Products", "item": [ { "name": "Search products", "description": "Operation ID: getV1Products", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1Products\n\nReturns one page of the published catalog together with the facets that apply to it, so a filter panel needs no second call. Every filter is optional and they combine.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products" ], "query": [ { "key": "productIds", "value": "[\"example\"]", "description": "Only these products.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "categories", "value": "[\"example\"]", "disabled": true }, { "key": "brands", "value": "[\"example\"]", "disabled": true }, { "key": "sellers", "value": "[\"example\"]", "disabled": true }, { "key": "collections", "value": "[\"example\"]", "disabled": true }, { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection.", "disabled": true }, { "key": "productTypes", "value": "[\"product\"]", "disabled": true }, { "key": "tags", "value": "[\"example\"]", "description": "Only items with any of these tags.", "disabled": true }, { "key": "filters", "value": "[\"example\"]", "disabled": true }, { "key": "inStock", "value": "false", "disabled": true }, { "key": "minPrice", "value": "1", "description": "Lowest price to include, in the store currency.", "disabled": true }, { "key": "maxPrice", "value": "1", "description": "Highest price to include, in the store currency.", "disabled": true }, { "key": "page", "value": "1", "description": "One-based page number.", "disabled": false }, { "key": "pageSize", "value": "1", "disabled": false }, { "key": "sort", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "List related products", "description": "Operation ID: getV1ProductsProductIdRelated", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1ProductsProductIdRelated\n\nReturns products related to the given one, for the recommendation block of a product page.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/products/{productId}/related", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":productId", "related" ], "query": [ { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true } ], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Create product review", "description": "Operation ID: postV1ProductsProductIdReviews", "request": { "method": "POST", "auth": { "type": "noauth" }, "description": "Operation ID: postV1ProductsProductIdReviews\n\nSubmits a review for a product. It is not published immediately: the merchant moderates it first.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/products/{productId}/reviews", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":productId", "reviews" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] }, "body": { "mode": "raw", "raw": "{\n \"rating\": 1,\n \"content\": \"example\",\n \"title\": \"Example title\",\n \"reviewerName\": \"Example resource\",\n \"reviewerEmail\": \"andrea@example.com\",\n \"orderId\": \"7204558912004325301\",\n \"reviewToken\": \"replace_with_the_issued_token\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product reviews", "description": "Operation ID: getV1ProductsProductIdReviews", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1ProductsProductIdReviews\n\nReturns the approved reviews of a product, paginated by cursor. Reviews awaiting moderation are not included.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/products/{productId}/reviews", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":productId", "reviews" ], "query": [ { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true }, { "key": "cursor", "value": "example", "description": "Opaque cursor from the previous response. Omit it on the first page.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "sortBy", "value": "example", "description": "Field to sort by. Accepted values depend on the resource.", "disabled": true }, { "key": "sortDirection", "value": "asc", "description": "Sort direction: `asc` or `desc`.", "disabled": true }, { "key": "rating", "value": "1", "disabled": true } ], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Get product by slug", "description": "Operation ID: getV1ProductsSlug", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1ProductsSlug\n\nReturns the full product page data: variants, media, specifications and stock. The slug is the one used in the storefront URL.", "header": [ { "key": "x-Store-Domain", "value": "{{storeDomain}}", "description": "Store slug or configured domain that selects the store context at the central Storefront gateway.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/products/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } } ] } ] }