{ "info": { "name": "Ecomiq Admin API 1.0.0", "description": "Back-office API for organizations, stores, catalog, inventory, customers, orders, fulfillment, shipping, payments, promotions, and webhooks.", "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://api.ecomiq.pe/api", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" } ], "item": [ { "name": "Catalog", "item": [ { "name": "Create brand", "description": "Operation ID: CreateBrand", "request": { "method": "POST", "description": "Operation ID: CreateBrand\n\nCreates a brand with its slug, media, SEO metadata, and display order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List brands", "description": "Operation ID: getV1CatalogBrands", "request": { "method": "GET", "description": "Operation ID: getV1CatalogBrands\n\nLists catalog brands by cursor, with text search, ID filtering, and sorting.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands" ], "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": "ids", "value": "[1]", "description": "Only these identifiers.", "disabled": true }, { "key": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [] } } }, { "name": "Delete a brand", "description": "Operation ID: deleteV1CatalogBrandsBrandId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CatalogBrandsBrandId\n\nDeletes a brand only when no products reference it.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/{brandId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", ":brandId" ], "query": [], "variable": [ { "key": "brandId", "value": "7204558912004325301", "description": "Identifier of the brand." } ] } } }, { "name": "Get brand by ID", "description": "Operation ID: getV1CatalogBrandsBrandId", "request": { "method": "GET", "description": "Operation ID: getV1CatalogBrandsBrandId\n\nReturns one brand with its media, SEO metadata, and display order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/{brandId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", ":brandId" ], "query": [], "variable": [ { "key": "brandId", "value": "7204558912004325301", "description": "Identifier of the brand." } ] } } }, { "name": "Update a brand", "description": "Operation ID: putV1CatalogBrandsBrandId", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogBrandsBrandId\n\nUpdates a brand's name, slug, media, SEO metadata, and display order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/{brandId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", ":brandId" ], "query": [], "variable": [ { "key": "brandId", "value": "7204558912004325301", "description": "Identifier of the brand." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export brands", "description": "Operation ID: ExportBrands", "request": { "method": "POST", "description": "Operation ID: ExportBrands\n\nQueues a brand export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"brandIds\": [\n 1\n ],\n \"status\": [\n \"inactive\"\n ],\n \"template\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import brands", "description": "Operation ID: ImportBrands", "request": { "method": "POST", "description": "Operation ID: ImportBrands\n\nQueues a brand import from a file. Returns a job you poll for progress.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } }, { "name": "Suggest brands", "description": "Operation ID: getV1CatalogBrandsSuggests", "request": { "method": "GET", "description": "Operation ID: getV1CatalogBrandsSuggests\n\nReturns up to 10 brands whose names start with the search text.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/brands/suggests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "brands", "suggests" ], "query": [ { "key": "q", "value": "example", "description": "Free-text search.", "disabled": false } ], "variable": [] } } }, { "name": "Create category", "description": "Operation ID: CreateCategory", "request": { "method": "POST", "description": "Operation ID: CreateCategory\n\nCreates a category, optionally under a parent, with SEO, size-guide, and commission settings.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List categories", "description": "Operation ID: getV1CatalogCategories", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCategories\n\nLists categories by cursor, with text search, parent and ID filters, and sorting.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories" ], "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": "parentId", "value": "7204558912004325301", "description": "Identifier of the parent.", "disabled": true }, { "key": "ids", "value": "[\"example\"]", "description": "Only these identifiers.", "disabled": true } ], "variable": [] } } }, { "name": "Delete a category", "description": "Operation ID: deleteV1CatalogCategoriesCategoryId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CatalogCategoriesCategoryId\n\nDelete an existing category (only if it has no subcategories or associated products)", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", ":categoryId" ], "query": [], "variable": [ { "key": "categoryId", "value": "7204558912004325301", "description": "Identifier of the category." } ] } } }, { "name": "Get category by ID", "description": "Operation ID: getV1CatalogCategoriesCategoryId", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCategoriesCategoryId\n\nReturns one category with its parent, children, specifications, SEO, and commission settings.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", ":categoryId" ], "query": [], "variable": [ { "key": "categoryId", "value": "7204558912004325301", "description": "Identifier of the category." } ] } } }, { "name": "Update a category", "description": "Operation ID: putV1CatalogCategoriesCategoryId", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogCategoriesCategoryId\n\nUpdates a category's parent, catalog metadata, SEO, size-guide requirement, and commission settings.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", ":categoryId" ], "query": [], "variable": [ { "key": "categoryId", "value": "7204558912004325301", "description": "Identifier of the category." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export categories", "description": "Operation ID: ExportCategories", "request": { "method": "POST", "description": "Operation ID: ExportCategories\n\nQueues a category export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"categoryIds\": [\n \"example\"\n ],\n \"parentId\": \"7204558912004325301\",\n \"status\": [\n \"inactive\"\n ],\n \"template\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import categories", "description": "Operation ID: ImportCategories", "request": { "method": "POST", "description": "Operation ID: ImportCategories\n\nQueues a category import from a file. Returns a job you poll for progress.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } }, { "name": "Suggest categories", "description": "Operation ID: getV1CatalogCategoriesSuggests", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCategoriesSuggests\n\nReturns up to 10 categories whose names start with the search text.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/suggests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", "suggests" ], "query": [ { "key": "q", "value": "example", "description": "Free-text search.", "disabled": false } ], "variable": [] } } }, { "name": "Get categories tree", "description": "Operation ID: getV1CatalogCategoriesTree", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCategoriesTree\n\nReturns the store's complete category hierarchy in display order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/tree", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", "tree" ], "query": [], "variable": [] } } }, { "name": "Update categories tree", "description": "Operation ID: putV1CatalogCategoriesTree", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogCategoriesTree\n\nReorders categories and changes their parent relationships in one request; cyclic hierarchies are rejected.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/categories/tree", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "categories", "tree" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"categories\": [\n {\n \"id\": \"7204558912004325301\",\n \"parentId\": \"7204558912004325301\",\n \"order\": 1,\n \"children\": []\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create collection", "description": "Operation ID: CreateCollection", "request": { "method": "POST", "description": "Operation ID: CreateCollection\n\nCreates a static or dynamic product collection.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"image\": {\n \"id\": \"7204558912004325301\",\n \"url\": \"https://example.com/resource\"\n },\n \"type\": \"static\",\n \"dynamicOperator\": \"and\",\n \"validFrom\": \"2026-08-01T15:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List collections", "description": "Operation ID: getV1CatalogCollections", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCollections\n\nList collections. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections" ], "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": "type", "value": "static", "description": "Only this type.", "disabled": true }, { "key": "status", "value": "draft", "description": "Only items in these statuses.", "disabled": true }, { "key": "types", "value": "[\"static\"]", "description": "Only these product types.", "disabled": true }, { "key": "statuses", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "excludeTypes", "value": "[\"static\"]", "description": "Leave out these product types.", "disabled": true }, { "key": "excludeStatuses", "value": "[\"draft\"]", "disabled": true }, { "key": "ids", "value": "[\"example\"]", "description": "Only these identifiers.", "disabled": true } ], "variable": [] } } }, { "name": "Delete collection", "description": "Operation ID: deleteV1CatalogCollectionsCollectionId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CatalogCollectionsCollectionId\n\nDelete collection. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/{collectionId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", ":collectionId" ], "query": [], "variable": [ { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection." } ] } } }, { "name": "Get collection", "description": "Operation ID: getV1CatalogCollectionsCollectionId", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCollectionsCollectionId\n\nReturns collection metadata, rules, overrides and counts. Product rows are available separately through the paginated collection products endpoint.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/{collectionId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", ":collectionId" ], "query": [], "variable": [ { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection." } ] } } }, { "name": "Update collection", "description": "Operation ID: putV1CatalogCollectionsCollectionId", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogCollectionsCollectionId\n\nUpdate collection. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/{collectionId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", ":collectionId" ], "query": [], "variable": [ { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"image\": {\n \"id\": \"7204558912004325301\",\n \"url\": \"https://example.com/resource\"\n },\n \"type\": \"static\",\n \"dynamicOperator\": \"and\",\n \"validFrom\": \"2026-08-01T15:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List collection products", "description": "Operation ID: getV1CatalogCollectionsCollectionIdProducts", "request": { "method": "GET", "description": "Operation ID: getV1CatalogCollectionsCollectionIdProducts\n\nReturns a paginated product summary for a collection. Use this endpoint to render collection products instead of loading raw product IDs from the collection detail.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/{collectionId}/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", ":collectionId", "products" ], "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": [ { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection." } ] } } }, { "name": "Set collection products", "description": "Operation ID: putV1CatalogCollectionsCollectionIdProducts", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogCollectionsCollectionIdProducts\n\nReplaces the manual product assignments for a static collection. Use product IDs only on write operations.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/{collectionId}/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", ":collectionId", "products" ], "query": [], "variable": [ { "key": "collectionId", "value": "7204558912004325301", "description": "Identifier of the collection." } ] }, "body": { "mode": "raw", "raw": "{\n \"productIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export collections", "description": "Operation ID: ExportCollections", "request": { "method": "POST", "description": "Operation ID: ExportCollections\n\nQueues a collection export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"collectionIds\": [\n \"example\"\n ],\n \"status\": [\n \"draft\"\n ],\n \"excludeStatus\": [\n \"draft\"\n ],\n \"type\": [\n \"static\"\n ],\n \"excludeType\": [\n \"static\"\n ],\n \"template\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import collections", "description": "Operation ID: ImportCollections", "request": { "method": "POST", "description": "Operation ID: ImportCollections\n\nQueues a collection import from a file. Returns a job you poll for progress.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } }, { "name": "Preview collection product count", "description": "Operation ID: PreviewCollectionCount", "request": { "method": "POST", "description": "Operation ID: PreviewCollectionCount\n\nCounts the products that match proposed collection rules and overrides without saving the collection.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/collections/preview-count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "collections", "preview-count" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"dynamicOperator\": \"and\",\n \"rules\": [\n {\n \"value\": \"example\",\n \"field\": \"price\",\n \"operator\": \"eq\",\n \"path\": \"example\"\n }\n ],\n \"includeCollectionIds\": [\n \"example\"\n ],\n \"excludeCollectionIds\": [\n \"example\"\n ],\n \"includeProductIds\": [\n \"example\"\n ],\n \"excludeProductIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List price history", "description": "Operation ID: getV1CatalogPriceHistory", "request": { "method": "GET", "description": "Operation ID: getV1CatalogPriceHistory\n\nReturns how a product's price changed over time, with the date of each change.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/price-history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "price-history" ], "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": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true }, { "key": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant.", "disabled": true }, { "key": "reason", "value": "initial", "description": "Reason recorded with the action.", "disabled": true }, { "key": "fromDate", "value": "2026-08-01T15:30:00Z", "description": "Start of the date range, inclusive.", "disabled": true }, { "key": "toDate", "value": "2026-08-01T15:30:00Z", "description": "End of the date range, inclusive.", "disabled": true } ], "variable": [] } } }, { "name": "Create price list", "description": "Operation ID: CreatePriceList", "request": { "method": "POST", "description": "Operation ID: CreatePriceList\n\nCreates a price list with its scope, rules, and variant prices.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/price-lists", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "price-lists" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"currency\": \"PEN\",\n \"isActive\": false,\n \"priority\": 1,\n \"scope\": \"product\",\n \"customerId\": \"7204558912004325301\",\n \"productId\": \"7204558912004325301\",\n \"productIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List price lists", "description": "Operation ID: getV1CatalogPriceLists", "request": { "method": "GET", "description": "Operation ID: getV1CatalogPriceLists\n\nList price lists. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/price-lists", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "price-lists" ], "query": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true } ], "variable": [] } } }, { "name": "Update price list", "description": "Operation ID: putV1CatalogPriceListsPriceListId", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogPriceListsPriceListId\n\nUpdate price list. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/price-lists/{priceListId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "price-lists", ":priceListId" ], "query": [], "variable": [ { "key": "priceListId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"currency\": \"PEN\",\n \"isActive\": false,\n \"priority\": 1,\n \"scope\": \"product\",\n \"customerId\": \"7204558912004325301\",\n \"productId\": \"7204558912004325301\",\n \"productIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product reviews", "description": "Operation ID: getV1CatalogProductReviews", "request": { "method": "GET", "description": "Operation ID: getV1CatalogProductReviews\n\nList product reviews. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/product-reviews", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "product-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": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true }, { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer.", "disabled": true }, { "key": "status", "value": "example", "description": "Only items in these statuses.", "disabled": true }, { "key": "rating", "value": "1", "disabled": true } ], "variable": [] } } }, { "name": "Get product review", "description": "Operation ID: getV1CatalogProductReviewsReviewId", "request": { "method": "GET", "description": "Operation ID: getV1CatalogProductReviewsReviewId\n\nGet product review. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/product-reviews/{reviewId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "product-reviews", ":reviewId" ], "query": [], "variable": [ { "key": "reviewId", "value": "7204558912004325301", "description": "Identifier of the review." } ] } } }, { "name": "Update review status", "description": "Operation ID: patchV1CatalogProductReviewsReviewIdStatus", "request": { "method": "PATCH", "description": "Operation ID: patchV1CatalogProductReviewsReviewIdStatus\n\nUpdate review status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/product-reviews/{reviewId}/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "product-reviews", ":reviewId", "status" ], "query": [], "variable": [ { "key": "reviewId", "value": "7204558912004325301", "description": "Identifier of the review." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"pending\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product recommendations", "description": "Operation ID: ListProductRecommendations", "request": { "method": "GET", "description": "Operation ID: ListProductRecommendations\n\nReturns products recommended for the specified catalog context.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/recommendations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "recommendations" ], "query": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true }, { "key": "category", "value": "example", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": false } ], "variable": [] } } }, { "name": "Create size guide", "description": "Operation ID: CreateSizeGuide", "request": { "method": "POST", "description": "Operation ID: CreateSizeGuide\n\nCreates a size guide. It only becomes visible on a product page once it is assigned.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"assignments\": [\n {\n \"targetType\": \"product\",\n \"targetId\": \"7204558912004325301\",\n \"includeChildrenCategories\": false,\n \"priority\": 1\n }\n ],\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"imageUrl\": \"https://example.com/resource\",\n \"gender\": \"unisex\",\n \"measurementType\": \"body\",\n \"unit\": \"cm\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List size guides", "description": "Operation ID: ListSizeGuides", "request": { "method": "GET", "description": "Operation ID: ListSizeGuides\n\nLists the size guides defined for the store.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides" ], "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": "gender", "value": "example", "description": "Gender the item is intended for.", "disabled": true }, { "key": "measurementType", "value": "example", "description": "Measurement type.", "disabled": true }, { "key": "status", "value": "example", "description": "Only items in these statuses.", "disabled": true }, { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true }, { "key": "categoryId", "value": "7204558912004325301", "description": "Identifier of the category.", "disabled": true } ], "variable": [] } } }, { "name": "Delete size guide", "description": "Operation ID: DeleteSizeGuide", "request": { "method": "DELETE", "description": "Operation ID: DeleteSizeGuide\n\nDeletes a size guide and removes it from the products using it.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/{sizeGuideId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", ":sizeGuideId" ], "query": [], "variable": [ { "key": "sizeGuideId", "value": "7204558912004325301", "description": "Identifier of the size guide." } ] } } }, { "name": "Get size guide", "description": "Operation ID: GetSizeGuide", "request": { "method": "GET", "description": "Operation ID: GetSizeGuide\n\nReturns one size guide with its measurement table.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/{sizeGuideId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", ":sizeGuideId" ], "query": [], "variable": [ { "key": "sizeGuideId", "value": "7204558912004325301", "description": "Identifier of the size guide." } ] } } }, { "name": "Update size guide", "description": "Operation ID: UpdateSizeGuide", "request": { "method": "PUT", "description": "Operation ID: UpdateSizeGuide\n\nUpdates a size guide. The change applies to every product it is assigned to.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/{sizeGuideId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", ":sizeGuideId" ], "query": [], "variable": [ { "key": "sizeGuideId", "value": "7204558912004325301", "description": "Identifier of the size guide." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"imageUrl\": \"https://example.com/resource\",\n \"gender\": \"unisex\",\n \"measurementType\": \"body\",\n \"unit\": \"cm\",\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assign size guide", "description": "Operation ID: AssignSizeGuide", "request": { "method": "POST", "description": "Operation ID: AssignSizeGuide\n\nAssigns a size guide to exactly one product or category; a category assignment may include descendant categories.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/{sizeGuideId}/assignments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", ":sizeGuideId", "assignments" ], "query": [], "variable": [ { "key": "sizeGuideId", "value": "7204558912004325301", "description": "Identifier of the size guide." } ] }, "body": { "mode": "raw", "raw": "{\n \"targetType\": \"product\",\n \"targetId\": \"7204558912004325301\",\n \"includeChildrenCategories\": false,\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove size guide assignment", "description": "Operation ID: RemoveSizeGuideAssignment", "request": { "method": "DELETE", "description": "Operation ID: RemoveSizeGuideAssignment\n\nDeletes one product or category assignment and recalculates which products still have an applicable guide.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/{sizeGuideId}/assignments/{assignmentId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", ":sizeGuideId", "assignments", ":assignmentId" ], "query": [], "variable": [ { "key": "sizeGuideId", "value": "7204558912004325301", "description": "Identifier of the size guide." }, { "key": "assignmentId", "value": "7204558912004325301" } ] } } }, { "name": "Export size guides", "description": "Operation ID: ExportSizeGuides", "request": { "method": "POST", "description": "Operation ID: ExportSizeGuides\n\nQueues a size guide export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"sizeGuideIds\": [\n \"example\"\n ],\n \"gender\": \"unisex\",\n \"measurementType\": \"body\",\n \"status\": \"draft\",\n \"sellerIds\": [\n \"example\"\n ],\n \"template\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import size guides", "description": "Operation ID: ImportSizeGuides", "request": { "method": "POST", "description": "Operation ID: ImportSizeGuides\n\nQueues a size guide import from a file. Returns a job you poll for progress.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/size-guides/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "size-guides", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } }, { "name": "Create specification", "description": "Operation ID: CreateSpecification", "request": { "method": "POST", "description": "Operation ID: CreateSpecification\n\nCreates a store-owned product specification with its key, behavior, and allowed values.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"key\": \"example\",\n \"aliases\": [\n \"example\"\n ],\n \"description\": \"Example description.\",\n \"isMultiple\": false,\n \"isRequired\": false,\n \"isFilterable\": false,\n \"isSearchable\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List specifications", "description": "Operation ID: getV1CatalogSpecifications", "request": { "method": "GET", "description": "Operation ID: getV1CatalogSpecifications\n\nLists specifications by cursor, with search, level, type, and repeated ID filters.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications" ], "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": "level", "value": "product", "disabled": true }, { "key": "type", "value": "input", "description": "Only this type.", "disabled": true }, { "key": "ids", "value": "[\"example\"]", "description": "Only these identifiers.", "disabled": true } ], "variable": [] } } }, { "name": "Delete a specification", "description": "Operation ID: deleteV1CatalogSpecificationsId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CatalogSpecificationsId\n\nDeletes a store-owned specification only when no category, product, or variant uses it.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get specification by ID", "description": "Operation ID: getV1CatalogSpecificationsId", "request": { "method": "GET", "description": "Operation ID: getV1CatalogSpecificationsId\n\nReturns one product specification with its aliases, behavior, metadata, and ordered values.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update a specification", "description": "Operation ID: putV1CatalogSpecificationsId", "request": { "method": "PUT", "description": "Operation ID: putV1CatalogSpecificationsId\n\nUpdates a store-owned specification and its values; seller-scoped callers cannot change it.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"key\": \"example\",\n \"aliases\": [\n \"example\"\n ],\n \"description\": \"Example description.\",\n \"isMultiple\": false,\n \"isRequired\": false,\n \"isFilterable\": false,\n \"isSearchable\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Suggest specifications", "description": "Operation ID: getV1CatalogSpecificationsSuggests", "request": { "method": "GET", "description": "Operation ID: getV1CatalogSpecificationsSuggests\n\nReturns up to 10 specifications matching the start of a name, key, or alias.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/specifications/suggests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "specifications", "suggests" ], "query": [ { "key": "q", "value": "example", "description": "Free-text search.", "disabled": false } ], "variable": [] } } }, { "name": "Save spreadsheet", "description": "Operation ID: SaveCatalogSpreadsheet", "request": { "method": "POST", "description": "Operation ID: SaveCatalogSpreadsheet\n\nSave spreadsheet. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/spreadsheet/save", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "spreadsheet", "save" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"brandUpdates\": [\n {\n \"brandId\": \"7204558912004325301\",\n \"body\": {\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n }\n }\n ],\n \"categoryUpdates\": [\n {\n \"categoryId\": \"7204558912004325301\",\n \"body\": {\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"description\": \"Example description.\",\n \"metaTitle\": \"Example title\",\n \"metaDescription\": \"Example description.\",\n \"keywords\": [\n \"example\"\n ]\n }\n }\n ],\n \"specificationUpdates\": [\n {\n \"specificationId\": \"7204558912004325301\",\n \"body\": {\n \"name\": \"Example resource\",\n \"key\": \"example\",\n \"aliases\": [\n \"example\"\n ],\n \"description\": \"Example description.\",\n \"isMultiple\": false,\n \"isRequired\": false,\n \"isFilterable\": false,\n \"isSearchable\": false\n }\n }\n ],\n \"sizeGuideUpdates\": [\n {\n \"sizeGuideId\": \"7204558912004325301\",\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"gender\": \"unisex\",\n \"measurementType\": \"body\",\n \"unit\": \"cm\",\n \"status\": \"draft\",\n \"priority\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List channel listings", "description": "Operation ID: getV1ChannelsChannelIdListings", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsChannelIdListings\n\nList channel listings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/listings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "listings" ], "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": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "readiness", "value": "[\"unknown\"]", "disabled": true }, { "key": "categoryIds", "value": "[\"example\"]", "description": "Only items in these categories.", "disabled": true }, { "key": "gender", "value": "[\"example\"]", "description": "Gender the item is intended for.", "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": "minStock", "value": "1", "description": "Minimum stock level.", "disabled": true }, { "key": "maxStock", "value": "1", "description": "Maximum stock level.", "disabled": true }, { "key": "issues", "value": "false", "disabled": true } ], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] } } }, { "name": "Update listings in bulk", "description": "Operation ID: postV1ChannelsChannelIdListingsBulk", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsChannelIdListingsBulk\n\nUpdate listings in bulk. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/listings/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "listings", "bulk" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1\n ],\n \"all\": false,\n \"status\": \"draft\",\n \"action\": \"publish\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listing counts by status for a channel", "description": "Operation ID: getV1ChannelsChannelIdListingsOverview", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsChannelIdListingsOverview\n\nListing counts by status for a channel. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/listings/overview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "listings", "overview" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] } } }, { "name": "Set listing requirements", "description": "Operation ID: putV1ChannelsChannelIdListingsRequirements", "request": { "method": "PUT", "description": "Operation ID: putV1ChannelsChannelIdListingsRequirements\n\nSet listing requirements. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/listings/requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "listings", "requirements" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] }, "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"listingId\": \"7204558912004325301\",\n \"values\": {\n \"key\": \"example\"\n }\n }\n ],\n \"republish\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List listing requirements", "description": "Operation ID: getV1ChannelsChannelIdListingsRequirements", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsChannelIdListingsRequirements\n\nList listing requirements. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/listings/requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "listings", "requirements" ], "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": "listingIds", "value": "[\"example\"]", "disabled": true }, { "key": "onlyMissing", "value": "false", "disabled": true }, { "key": "categoryIds", "value": "[\"example\"]", "description": "Only items in these categories.", "disabled": true }, { "key": "gender", "value": "[\"example\"]", "description": "Gender the item is intended for.", "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": "minStock", "value": "1", "description": "Minimum stock level.", "disabled": true }, { "key": "maxStock", "value": "1", "description": "Maximum stock level.", "disabled": true } ], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] } } }, { "name": "Publish a product to a channel", "description": "Operation ID: postV1ChannelsChannelIdProductsProductIdPublish", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsChannelIdProductsProductIdPublish\n\nPublish a product to a channel. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/products/{productId}/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "products", ":productId", "publish" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." }, { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Queue publication for ready listings", "description": "Operation ID: postV1ChannelsChannelIdPublicationPublish", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsChannelIdPublicationPublish\n\nQueue publication for ready listings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/publication/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "publication", "publish" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] } } }, { "name": "Get publication readiness", "description": "Operation ID: getV1ChannelsChannelIdPublicationReadiness", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsChannelIdPublicationReadiness\n\nGet publication readiness. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/{channelId}/publication/readiness", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", ":channelId", "publication", "readiness" ], "query": [], "variable": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel." } ] } } }, { "name": "Create listing", "description": "Operation ID: postV1ChannelsListings", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsListings\n\nCreate listing. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"channelId\": \"7204558912004325301\",\n \"productId\": \"7204558912004325301\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"syncInventory\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List listings", "description": "Operation ID: getV1ChannelsListings", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsListings\n\nList listings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings" ], "query": [ { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel.", "disabled": true }, { "key": "listingType", "value": "salesChannel", "disabled": true }, { "key": "status", "value": "draft", "description": "Only items in these statuses.", "disabled": true }, { "key": "take", "value": "1", "disabled": true } ], "variable": [] } } }, { "name": "Get listing by ID", "description": "Operation ID: getV1ChannelsListingsId", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsListingsId\n\nGet listing by ID. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Link existing publication", "description": "Operation ID: postV1ChannelsListingsIdAdoptPublication", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsListingsIdAdoptPublication\n\nLink existing publication. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/adopt-publication", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "adopt-publication" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set listing overrides", "description": "Operation ID: putV1ChannelsListingsIdOverrides", "request": { "method": "PUT", "description": "Operation ID: putV1ChannelsListingsIdOverrides\n\nSet listing overrides. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/overrides", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "overrides" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"overrides\": [\n {\n \"target\": \"name\",\n \"value\": \"example\",\n \"attributeId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\"\n }\n ],\n \"republish\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update listing price", "description": "Operation ID: patchV1ChannelsListingsIdPrice", "request": { "method": "PATCH", "description": "Operation ID: patchV1ChannelsListingsIdPrice\n\nUpdate listing price. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/price", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "price" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"price\": 1,\n \"compareAtPrice\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Queue publication for a listing", "description": "Operation ID: postV1ChannelsListingsIdPublish", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsListingsIdPublish\n\nQueue publication for a listing. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "publish" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get the channel requirements for a listing", "description": "Operation ID: getV1ChannelsListingsIdRequirements", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsListingsIdRequirements\n\nGet the channel requirements for a listing. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "requirements" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List listing size charts", "description": "Operation ID: getV1ChannelsListingsIdSizeCharts", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsListingsIdSizeCharts\n\nList listing size charts. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/size-charts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "size-charts" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true } ], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List size chart rows", "description": "Operation ID: getV1ChannelsListingsIdSizeChartsChartIdRows", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsListingsIdSizeChartsChartIdRows\n\nList size chart rows. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/size-charts/{chartId}/rows", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "size-charts", ":chartId", "rows" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." }, { "key": "chartId", "value": "7204558912004325301" } ] } } }, { "name": "Unpublish a listing", "description": "Operation ID: postV1ChannelsListingsIdUnpublish", "request": { "method": "POST", "description": "Operation ID: postV1ChannelsListingsIdUnpublish\n\nUnpublish a listing. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/listings/{id}/unpublish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "listings", ":id", "unpublish" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List product publications", "description": "Operation ID: getV1ChannelsProductsProductIdPublications", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsProductsProductIdPublications\n\nList product publications. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/products/{productId}/publications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "products", ":productId", "publications" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "List product publications", "description": "Operation ID: getV1ChannelsProductsPublications", "request": { "method": "GET", "description": "Operation ID: getV1ChannelsProductsPublications\n\nList product publications. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/channels/products/publications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels", "products", "publications" ], "query": [ { "key": "productIds", "value": "[\"example\"]", "description": "Only these products.", "disabled": false } ], "variable": [] } } }, { "name": "Create template", "description": "Operation ID: postV1NotificationsTemplates", "request": { "method": "POST", "description": "Operation ID: postV1NotificationsTemplates\n\nCreate template. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"group\": \"example\",\n \"key\": \"example\",\n \"name\": \"Example resource\",\n \"notification\": \"email\",\n \"locale\": \"example\",\n \"subjectTpl\": \"example\",\n \"bodyTpl\": \"example\",\n \"engine\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List templates", "description": "Operation ID: ListTemplates", "request": { "method": "GET", "description": "Operation ID: ListTemplates\n\nList templates. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates" ], "query": [ { "key": "page", "value": "1", "description": "One-based page number.", "disabled": true }, { "key": "pageSize", "value": "1", "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": "channel", "value": "email", "description": "Sales channel code.", "disabled": true }, { "key": "groups", "value": "[\"example\"]", "disabled": false }, { "key": "statuses", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "key", "value": "example", "disabled": true }, { "key": "locale", "value": "example", "description": "Language code for localized content.", "disabled": true }, { "key": "scope", "value": "system", "description": "Scope of the operation.", "disabled": true } ], "variable": [] } } }, { "name": "Update draft template", "description": "Operation ID: putV1NotificationsTemplatesId", "request": { "method": "PUT", "description": "Operation ID: putV1NotificationsTemplatesId\n\nUpdate draft template. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"subjectTpl\": \"example\",\n \"bodyTpl\": \"example\",\n \"textTpl\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Publish template", "description": "Operation ID: postV1NotificationsTemplatesIdPublish", "request": { "method": "POST", "description": "Operation ID: postV1NotificationsTemplatesIdPublish\n\nPublish template. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{id}/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":id", "publish" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get template by ID", "description": "Operation ID: GetTemplateById", "request": { "method": "GET", "description": "Operation ID: GetTemplateById\n\nGet template by ID. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{templateId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":templateId" ], "query": [], "variable": [ { "key": "templateId", "value": "7204558912004325301", "description": "Identifier of the template." } ] } } }, { "name": "List template versions by ID", "description": "Operation ID: ListTemplateVersionsById", "request": { "method": "GET", "description": "Operation ID: ListTemplateVersionsById\n\nList template versions by ID. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{templateId}/versions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":templateId", "versions" ], "query": [], "variable": [ { "key": "templateId", "value": "7204558912004325301", "description": "Identifier of the template." } ] } } }, { "name": "Get template", "description": "Operation ID: GetTemplate", "request": { "method": "GET", "description": "Operation ID: GetTemplate\n\nGet template. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{templateKey}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":templateKey" ], "query": [ { "key": "channel", "value": "email", "description": "Sales channel code.", "disabled": false }, { "key": "locale", "value": "example", "description": "Language code for localized content.", "disabled": true } ], "variable": [ { "key": "templateKey", "value": "example", "description": "Key of the template." } ] } } }, { "name": "List template versions by key", "description": "Operation ID: ListTemplateVersionsByKey", "request": { "method": "GET", "description": "Operation ID: ListTemplateVersionsByKey\n\nList template versions by key. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/{templateKey}/versions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", ":templateKey", "versions" ], "query": [ { "key": "channel", "value": "email", "description": "Sales channel code.", "disabled": true }, { "key": "locale", "value": "example", "description": "Language code for localized content.", "disabled": true } ], "variable": [ { "key": "templateKey", "value": "example", "description": "Key of the template." } ] } } }, { "name": "List template groups", "description": "Operation ID: ListTemplateGroups", "request": { "method": "GET", "description": "Operation ID: ListTemplateGroups\n\nList template groups. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/notifications/templates/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "templates", "groups" ], "query": [ { "key": "scope", "value": "system", "description": "Scope of the operation.", "disabled": true }, { "key": "channel", "value": "email", "description": "Sales channel code.", "disabled": true } ], "variable": [] } } } ] }, { "name": "Customers", "item": [ { "name": "Create customer", "description": "Operation ID: CreateCustomer", "request": { "method": "POST", "description": "Operation ID: CreateCustomer\n\nCreates a customer record for the current store; email addresses must be unique within that store.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"customerType\": \"individual\",\n \"countryIsoCode\": \"PE\",\n \"phone\": \"+51987654321\",\n \"identificationType\": \"DNI\",\n \"identificationNumber\": \"72654321\",\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List customers", "description": "Operation ID: getV1Customers", "request": { "method": "GET", "description": "Operation ID: getV1Customers\n\nLists store customers by cursor, with search and status, type, group, ID, or verification filters.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true }, { "key": "isVerified", "value": "false", "disabled": true }, { "key": "customerType", "value": "[\"individual\"]", "disabled": true }, { "key": "status", "value": "[\"active\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "groupId", "value": "7204558912004325301", "disabled": true }, { "key": "customerIds", "value": "[\"example\"]", "disabled": true } ], "variable": [] } } }, { "name": "Create customer address", "description": "Operation ID: postV1CustomersCustomerIdAddresses", "request": { "method": "POST", "description": "Operation ID: postV1CustomersCustomerIdAddresses\n\nAdds a saved address to a customer and optionally makes it the default.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customerId}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "addresses" ], "query": [], "variable": [ { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer." } ] }, "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: getV1CustomersCustomerIdAddresses", "request": { "method": "GET", "description": "Operation ID: getV1CustomersCustomerIdAddresses\n\nLists a customer's saved addresses and identifies the current default.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customerId}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "addresses" ], "query": [], "variable": [ { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer." } ] } } }, { "name": "Delete customer address", "description": "Operation ID: deleteV1CustomersCustomerIdAddressesAddressId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CustomersCustomerIdAddressesAddressId\n\nRemoves one saved address from a customer.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customerId}/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "addresses", ":addressId" ], "query": [], "variable": [ { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer." }, { "key": "addressId", "value": "7204558912004325301" } ] } } }, { "name": "Update customer address", "description": "Operation ID: putV1CustomersCustomerIdAddressesAddressId", "request": { "method": "PUT", "description": "Operation ID: putV1CustomersCustomerIdAddressesAddressId\n\nUpdates a customer's saved address and optionally makes it the default.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customerId}/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "addresses", ":addressId" ], "query": [], "variable": [ { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer." }, { "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": "Delete customer", "description": "Operation ID: deleteV1CustomersId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CustomersId\n\nSoft-deletes a customer record from the current store.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get customer", "description": "Operation ID: getV1CustomersId", "request": { "method": "GET", "description": "Operation ID: getV1CustomersId\n\nReturns the profile and account details of one customer in the current store.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update customer", "description": "Operation ID: putV1CustomersId", "request": { "method": "PUT", "description": "Operation ID: putV1CustomersId\n\nUpdates a customer's profile, identity, company, country, and consent fields; it does not change email or addresses.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "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\": \"other\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export customers", "description": "Operation ID: postV1CustomersExports", "request": { "method": "POST", "description": "Operation ID: postV1CustomersExports\n\nQueues a customer export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"isActive\": false,\n \"isVerified\": false,\n \"customerType\": \"individual\",\n \"customerTypes\": [\n \"individual\"\n ],\n \"status\": \"active\",\n \"statuses\": [\n \"active\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create customer group", "description": "Operation ID: postV1CustomersGroups", "request": { "method": "POST", "description": "Operation ID: postV1CustomersGroups\n\nCreates a customer group. Members are added separately.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"isActive\": true,\n \"type\": \"manual\",\n \"criteria\": {\n \"minTotalSpent\": 1,\n \"minOrders\": 1,\n \"lastOrderWithinDays\": 1,\n \"windowDays\": 1,\n \"categoryId\": \"7204558912004325301\",\n \"salesChannel\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List customer groups", "description": "Operation ID: getV1CustomersGroups", "request": { "method": "GET", "description": "Operation ID: getV1CustomersGroups\n\nLists customer groups with cursor pagination, text search, active-state filtering, and sorting.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [] } } }, { "name": "Delete customer group", "description": "Operation ID: deleteV1CustomersGroupsId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1CustomersGroupsId\n\nDeletes a customer group. Its members are not deleted, only their membership.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get customer group", "description": "Operation ID: getV1CustomersGroupsId", "request": { "method": "GET", "description": "Operation ID: getV1CustomersGroupsId\n\nReturns one customer group with its member count.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update customer group", "description": "Operation ID: putV1CustomersGroupsId", "request": { "method": "PUT", "description": "Operation ID: putV1CustomersGroupsId\n\nUpdates a customer group's name and settings, without touching its members.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"isActive\": true,\n \"type\": \"manual\",\n \"criteria\": {\n \"minTotalSpent\": 1,\n \"minOrders\": 1,\n \"lastOrderWithinDays\": 1,\n \"windowDays\": 1,\n \"categoryId\": \"7204558912004325301\",\n \"salesChannel\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add customers to a customer group", "description": "Operation ID: postV1CustomersGroupsIdMembers", "request": { "method": "POST", "description": "Operation ID: postV1CustomersGroupsIdMembers\n\nAdds customers to a group. Customers already in it are ignored.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/{id}/members", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", ":id", "members" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove customers from a customer group", "description": "Operation ID: postV1CustomersGroupsIdMembersRemove", "request": { "method": "POST", "description": "Operation ID: postV1CustomersGroupsIdMembersRemove\n\nRemoves customers from a group without deleting the customers.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/{id}/members/remove", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", ":id", "members", "remove" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Preview a dynamic audience", "description": "Operation ID: postV1CustomersGroupsPreview", "request": { "method": "POST", "description": "Operation ID: postV1CustomersGroupsPreview\n\nCounts the customers that currently match the given dynamic criteria.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/groups/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "groups", "preview" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"criteria\": {\n \"minTotalSpent\": 1,\n \"minOrders\": 1,\n \"lastOrderWithinDays\": 1,\n \"windowDays\": 1,\n \"categoryId\": \"7204558912004325301\",\n \"salesChannel\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import customers", "description": "Operation ID: postV1CustomersImport", "request": { "method": "POST", "description": "Operation ID: postV1CustomersImport\n\nQueues a customer import from a file. Returns a job you poll for progress and errors.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } }, { "name": "Create customer spreadsheet", "description": "Operation ID: CreateCustomerSpreadsheet", "request": { "method": "POST", "description": "Operation ID: CreateCustomerSpreadsheet\n\nCreate customer spreadsheet. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/spreadsheet", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "spreadsheet" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"example\"\n ],\n \"filters\": {\n \"search\": \"polo\",\n \"isActive\": false,\n \"isVerified\": false,\n \"customerType\": \"individual\",\n \"customerTypes\": [\n \"individual\"\n ],\n \"status\": \"active\",\n \"statuses\": [\n \"active\"\n ],\n \"groupId\": \"7204558912004325301\"\n },\n \"pageSize\": 1,\n \"maxRows\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get customer spreadsheet", "description": "Operation ID: GetCustomerSpreadsheet", "request": { "method": "GET", "description": "Operation ID: GetCustomerSpreadsheet\n\nGet customer spreadsheet. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/spreadsheet/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "spreadsheet", ":id" ], "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": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Save customer spreadsheet", "description": "Operation ID: SaveCustomerSpreadsheet", "request": { "method": "POST", "description": "Operation ID: SaveCustomerSpreadsheet\n\nSave customer spreadsheet. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/customers/spreadsheet/save", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "spreadsheet", "save" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"customerId\": \"7204558912004325301\",\n \"body\": {\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\": \"other\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Fulfillment & Shipping", "item": [ { "name": "Create location", "description": "Operation ID: postV1FulfillmentLocations", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentLocations\n\nCreates a fulfillment location with its capabilities, schedules, pickup, and local-delivery settings.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "locations" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"code\": \"example_code\",\n \"type\": \"warehouse\",\n \"address\": \"example\",\n \"city\": \"example\",\n \"state\": \"example\",\n \"country\": \"PE\",\n \"postalCode\": \"example_code\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List locations", "description": "Operation ID: getV1FulfillmentLocations", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentLocations\n\nLists fulfillment locations by cursor, with name or code search and an active filter.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "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 }, { "key": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [] } } }, { "name": "Delete a location", "description": "Operation ID: deleteV1FulfillmentLocationsId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1FulfillmentLocationsId\n\nDeletes a non-default location only after its inventory, active transfers, and open fulfillment orders are cleared.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "locations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get location by ID", "description": "Operation ID: getV1FulfillmentLocationsId", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentLocationsId\n\nReturns one fulfillment location with its address, capabilities, schedules, pickup, and local-delivery settings.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "locations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update a location", "description": "Operation ID: putV1FulfillmentLocationsId", "request": { "method": "PUT", "description": "Operation ID: putV1FulfillmentLocationsId\n\nUpdates a fulfillment location's address, capabilities, schedules, pickup, local-delivery, priority, and default state.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "locations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"code\": \"example_code\",\n \"type\": \"warehouse\",\n \"address\": \"example\",\n \"city\": \"example\",\n \"state\": \"example\",\n \"country\": \"PE\",\n \"postalCode\": \"example_code\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set default location", "description": "Operation ID: UpsertDefaultLocation", "request": { "method": "PUT", "description": "Operation ID: UpsertDefaultLocation\n\nReturns the active default fulfillment location. If none exists, promotes an active location or creates the Main Warehouse.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/locations/default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "locations", "default" ], "query": [], "variable": [] } } }, { "name": "List fulfillment orders", "description": "Operation ID: getV1FulfillmentOrders", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentOrders\n\nLists the work to be fulfilled. One customer order becomes several fulfillment orders when its items ship from different locations.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "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 }, { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order.", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "status", "value": "[\"pendingAssignment\"]", "description": "Only items in these statuses.", "disabled": true } ], "variable": [] } } }, { "name": "Get fulfillment order", "description": "Operation ID: getV1FulfillmentOrdersId", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentOrdersId\n\nReturns one fulfillment order with its status, items, shipments and assigned location when present.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Assign fulfillment order", "description": "Operation ID: postV1FulfillmentOrdersIdAssign", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdAssign\n\nAssigns the fulfillment order to a location, which becomes responsible for preparing it.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/assign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "assign" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"locationId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel fulfillment order", "description": "Operation ID: postV1FulfillmentOrdersIdCancel", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdCancel\n\nCancels the fulfillment. Any stock reserved for it is released.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "cancel" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Deliver fulfillment order", "description": "Operation ID: postV1FulfillmentOrdersIdDeliver", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdDeliver\n\nMoves an assigned in-progress, ready-for-pickup or shipped fulfillment order to delivered.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "deliver" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Set fulfillment order in progress", "description": "Operation ID: postV1FulfillmentOrdersIdInProgress", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdInProgress\n\nMarks that preparation has started. Use it to distinguish what is being picked from what is still queued.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/in-progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "in-progress" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get packing slip", "description": "Operation ID: getV1FulfillmentOrdersIdPackingSlip", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentOrdersIdPackingSlip\n\nReturns one packing slip per shipment, or one order packing slip when the order has not shipped yet.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/packing-slip", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "packing-slip" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Pick up fulfillment order", "description": "Operation ID: postV1FulfillmentOrdersIdPickUp", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdPickUp\n\nMoves an assigned ready-for-pickup fulfillment order to delivered.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/pick-up", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "pick-up" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Set fulfillment order ready to pick up", "description": "Operation ID: postV1FulfillmentOrdersIdReadyToPickup", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdReadyToPickup\n\nMoves an assigned pending or in-progress fulfillment order to ready for pickup.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/ready-to-pickup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "ready-to-pickup" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Ship fulfillment order", "description": "Operation ID: postV1FulfillmentOrdersIdShip", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdShip\n\nMarks the declared item selection as shipped. From here it is tracked by its shipment.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/ship", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "ship" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"origin\": \"manual\",\n \"shippingConnectionId\": \"7204558912004325301\",\n \"shipmentId\": \"7204558912004325301\",\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"labelUrl\": \"https://example.com/resource\",\n \"carrierName\": \"Example resource\",\n \"packageId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create fulfillment shipment", "description": "Operation ID: postV1FulfillmentOrdersIdShipment", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersIdShipment\n\nCreates a carrier shipment from explicit item, package and connection selections, then stores the provider response.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/shipment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "shipment" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"itemSelection\": \"all\",\n \"packageSelection\": \"automatic\",\n \"connectionSelection\": \"orderDefault\",\n \"shippingConnectionId\": \"7204558912004325301\",\n \"serviceCode\": \"example_code\",\n \"packageId\": \"7204558912004325301\",\n \"weight\": 1,\n \"weightUnit\": \"kilogram\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get shipment label", "description": "Operation ID: GetFulfillmentShipmentLabel", "request": { "method": "GET", "description": "Operation ID: GetFulfillmentShipmentLabel\n\nGet shipment label. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/shipments/{shipmentId}/label", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "shipments", ":shipmentId", "label" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." }, { "key": "shipmentId", "value": "7204558912004325301", "description": "Identifier of the shipment." } ] } } }, { "name": "Get shipment packing slip", "description": "Operation ID: getV1FulfillmentOrdersIdShipmentsShipmentIdPackingSlip", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentOrdersIdShipmentsShipmentIdPackingSlip\n\nGet shipment packing slip. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/shipments/{shipmentId}/packing-slip", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "shipments", ":shipmentId", "packing-slip" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." }, { "key": "shipmentId", "value": "7204558912004325301", "description": "Identifier of the shipment." } ] } } }, { "name": "Get shipment tracking", "description": "Operation ID: GetFulfillmentShipmentTracking", "request": { "method": "GET", "description": "Operation ID: GetFulfillmentShipmentTracking\n\nGet shipment tracking. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/{id}/shipments/{shipmentId}/tracking", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", ":id", "shipments", ":shipmentId", "tracking" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." }, { "key": "shipmentId", "value": "7204558912004325301", "description": "Identifier of the shipment." } ] } } }, { "name": "Export shipping labels", "description": "Operation ID: postV1FulfillmentOrdersLabelsExport", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersLabelsExport\n\nQueues a background operation that bundles every shipment label of the given fulfillment orders into a zip file.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/labels/export", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", "labels", "export" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get packing slips batch", "description": "Operation ID: postV1FulfillmentOrdersPackingSlips", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersPackingSlips\n\nReturns one printable document with every shipment packing slip of the given fulfillment orders. Orders without shipments produce one order-level slip.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/packing-slips", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", "packing-slips" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export packing slips", "description": "Operation ID: postV1FulfillmentOrdersPackingSlipsExport", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentOrdersPackingSlipsExport\n\nExport packing slips. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/packing-slips/export", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", "packing-slips", "export" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get order by tracking number", "description": "Operation ID: GetFulfillmentOrderByTracking", "request": { "method": "GET", "description": "Operation ID: GetFulfillmentOrderByTracking\n\nReturns the fulfillment order associated with a carrier tracking number.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/orders/tracking/{trackingNumber}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "orders", "tracking", ":trackingNumber" ], "query": [ { "key": "shippingConnectionId", "value": "7204558912004325301", "disabled": false } ], "variable": [ { "key": "trackingNumber", "value": "example" } ] } } }, { "name": "Create package", "description": "Operation ID: postV1FulfillmentPackages", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentPackages\n\nCreates a reusable package format with dimensions, empty weight, units, status, and default selection.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "packages" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"type\": \"box\",\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimensionUnit\": \"centimeter\",\n \"emptyWeight\": 1,\n \"weightUnit\": \"kilogram\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List packages", "description": "Operation ID: getV1FulfillmentPackages", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentPackages\n\nLists active package formats by default; set includeInactive to include inactive formats. A package can be selected when creating a carrier shipment.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "packages" ], "query": [ { "key": "includeInactive", "value": "false", "disabled": true } ], "variable": [] } } }, { "name": "Delete package", "description": "Operation ID: deleteV1FulfillmentPackagesId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1FulfillmentPackagesId\n\nDeletes a package format. If it was the default, another active format becomes default when available.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/packages/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "packages", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get package", "description": "Operation ID: getV1FulfillmentPackagesId", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentPackagesId\n\nReturns one package format with its dimensions and weight.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/packages/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "packages", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update package", "description": "Operation ID: putV1FulfillmentPackagesId", "request": { "method": "PUT", "description": "Operation ID: putV1FulfillmentPackagesId\n\nUpdates a reusable package format, including dimensions, empty weight, units, status, and default selection.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/packages/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "packages", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"type\": \"box\",\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimensionUnit\": \"centimeter\",\n \"emptyWeight\": 1,\n \"weightUnit\": \"kilogram\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Preview routing", "description": "Operation ID: postV1FulfillmentRoutingPreview", "request": { "method": "POST", "description": "Operation ID: postV1FulfillmentRoutingPreview\n\nShows which locations would fulfill an order and how it would split, without committing anything.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/routing/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "routing", "preview" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"allowSplitFulfillment\": false,\n \"items\": [\n {\n \"variantId\": \"7204558912004325301\",\n \"quantity\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get fulfillment settings", "description": "Operation ID: getV1FulfillmentSettings", "request": { "method": "GET", "description": "Operation ID: getV1FulfillmentSettings\n\nReturns the fulfillment rules of the store: how orders are routed and split.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "settings" ], "query": [], "variable": [] } } }, { "name": "Update fulfillment settings", "description": "Operation ID: putV1FulfillmentSettings", "request": { "method": "PUT", "description": "Operation ID: putV1FulfillmentSettings\n\nUpdates routing, split-fulfillment and packing-slip settings. Routing changes affect future routing; packing-slip values are read when a slip is generated.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/fulfillment/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "fulfillment", "settings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"routingMode\": \"defaultLocation\",\n \"splitFulfillmentEnabled\": false,\n \"packingSlipSenderName\": \"Example resource\",\n \"packingSlipSenderPhone\": \"+51987654321\",\n \"packingSlipSenderEmail\": \"andrea@example.com\",\n \"packingSlipNotes\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "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": "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": "Cancel fulfillment orders for an order", "description": "Operation ID: CancelFulfillmentOrdersByOrder", "request": { "method": "DELETE", "description": "Operation ID: CancelFulfillmentOrdersByOrder\n\nCancels the fulfillment orders created for one customer order and returns how many were canceled.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/fulfillment-orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "fulfillment-orders" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "List fulfillment orders for an order", "description": "Operation ID: ListFulfillmentOrdersByOrder", "request": { "method": "GET", "description": "Operation ID: ListFulfillmentOrdersByOrder\n\nLists the fulfillment orders created for one customer order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/fulfillment-orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "fulfillment-orders" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Get order label", "description": "Operation ID: GetOrderLabel", "request": { "method": "GET", "description": "Operation ID: GetOrderLabel\n\nGet order label. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/label", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "label" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Create shipment for an order", "description": "Operation ID: CreateShipment", "request": { "method": "POST", "description": "Operation ID: CreateShipment\n\nCreates a shipment when the order has exactly one fulfillment order; split orders must be shipped from fulfillment.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/shipment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "shipment" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"itemSelection\": \"all\",\n \"packageSelection\": \"automatic\",\n \"connectionSelection\": \"orderDefault\",\n \"packageId\": \"7204558912004325301\",\n \"shippingConnectionId\": \"7204558912004325301\",\n \"items\": [\n {\n \"orderItemId\": \"7204558912004325301\",\n \"quantity\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get order tracking", "description": "Operation ID: GetOrderTracking", "request": { "method": "GET", "description": "Operation ID: GetOrderTracking\n\nGet order tracking. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/tracking", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "tracking" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "List shipping coverage", "description": "Operation ID: ListShippingCoverage", "request": { "method": "GET", "description": "Operation ID: ListShippingCoverage\n\nList shipping coverage. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/coverage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "coverage" ], "query": [ { "key": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [] } } }, { "name": "Create shipping customization", "description": "Operation ID: CreateShippingCustomization", "request": { "method": "POST", "description": "Operation ID: CreateShippingCustomization\n\nCreate shipping customization. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/customizations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "customizations" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"name\": \"Example resource\",\n \"priority\": 1,\n \"isActive\": false,\n \"hideInCheckout\": false,\n \"displayName\": \"Example resource\",\n \"sortOrder\": 1,\n \"sellerId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping customizations", "description": "Operation ID: ListShippingCustomizations", "request": { "method": "GET", "description": "Operation ID: ListShippingCustomizations\n\nList shipping customizations. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/customizations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "customizations" ], "query": [], "variable": [] } } }, { "name": "Delete shipping customization", "description": "Operation ID: DeleteShippingCustomization", "request": { "method": "DELETE", "description": "Operation ID: DeleteShippingCustomization\n\nDelete shipping customization. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/customizations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "customizations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get shipping customization", "description": "Operation ID: GetShippingCustomization", "request": { "method": "GET", "description": "Operation ID: GetShippingCustomization\n\nGet shipping customization. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/customizations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "customizations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update shipping customization", "description": "Operation ID: UpdateShippingCustomization", "request": { "method": "PUT", "description": "Operation ID: UpdateShippingCustomization\n\nUpdate shipping customization. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/customizations/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "customizations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"name\": \"Example resource\",\n \"priority\": 1,\n \"isActive\": false,\n \"hideInCheckout\": false,\n \"displayName\": \"Example resource\",\n \"sortOrder\": 1,\n \"sellerId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create non-working date range", "description": "Operation ID: postV1ShippingHolidays", "request": { "method": "POST", "description": "Operation ID: postV1ShippingHolidays\n\nCreates a non-working date range that delivery estimates must skip.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/holidays", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "holidays" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"fromDate\": \"2026-08-01\",\n \"toDate\": \"2026-08-01\",\n \"description\": \"Example description.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List non-working date ranges", "description": "Operation ID: getV1ShippingHolidays", "request": { "method": "GET", "description": "Operation ID: getV1ShippingHolidays\n\nLists non-working date ranges with name search and active or year filters.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/holidays", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "holidays" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true }, { "key": "year", "value": "2026-08-01T15:30:00Z", "disabled": true } ], "variable": [] } } }, { "name": "Delete non-working date range", "description": "Operation ID: deleteV1ShippingHolidaysId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1ShippingHolidaysId\n\nDeletes a non-working date range from the store's delivery calendar.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/holidays/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "holidays", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get non-working date range", "description": "Operation ID: GetHoliday", "request": { "method": "GET", "description": "Operation ID: GetHoliday\n\nReturns one non-working date range.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/holidays/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "holidays", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update non-working date range", "description": "Operation ID: UpdateHoliday", "request": { "method": "PUT", "description": "Operation ID: UpdateHoliday\n\nUpdates a non-working date range. Delivery estimates skip dates within that range.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/holidays/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "holidays", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"fromDate\": \"2026-08-01\",\n \"toDate\": \"2026-08-01\",\n \"description\": \"Example description.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create shipping method", "description": "Operation ID: CreateShippingMethod", "request": { "method": "POST", "description": "Operation ID: CreateShippingMethod\n\nCreates a shipping or pickup method with its price, eligibility limits, schedule, provider connection, and checkout visibility.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"displayName\": \"Example resource\",\n \"type\": \"regular\",\n \"basePrice\": 1,\n \"currency\": \"PEN\",\n \"estimatedDeliveryDays\": 1,\n \"estimatedDeliveryHours\": 1,\n \"allowShowCalendar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping methods", "description": "Operation ID: ListShippingMethods", "request": { "method": "GET", "description": "Operation ID: ListShippingMethods\n\nLists shipping methods with search and active, checkout, type, and profile filters. With onlyAvailable enabled, filters by location capability; postalCode applies only to local-delivery coverage.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true }, { "key": "visibleInCheckout", "value": "false", "disabled": true }, { "key": "onlyAvailable", "value": "false", "disabled": true }, { "key": "postalCode", "value": "example_code", "disabled": true }, { "key": "type", "value": "regular", "description": "Only this type.", "disabled": true }, { "key": "shippingProfileId", "value": "7204558912004325301", "description": "Identifier of the shipping profile.", "disabled": true } ], "variable": [] } } }, { "name": "Delete shipping method", "description": "Operation ID: DeleteShippingMethod", "request": { "method": "DELETE", "description": "Operation ID: DeleteShippingMethod\n\nDeletes a shipping method owned by the current store or seller.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get shipping method", "description": "Operation ID: GetShippingMethod", "request": { "method": "GET", "description": "Operation ID: GetShippingMethod\n\nReturns one shipping method with pricing, eligibility, available days, connection ID, pickup-point IDs and embedded rates.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update shipping method", "description": "Operation ID: UpdateShippingMethod", "request": { "method": "PUT", "description": "Operation ID: UpdateShippingMethod\n\nUpdates a shipping or pickup method's price, eligibility limits, schedule, provider connection, pickup points, and checkout visibility.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"displayName\": \"Example resource\",\n \"type\": \"regular\",\n \"basePrice\": 1,\n \"currency\": \"PEN\",\n \"estimatedDeliveryDays\": 1,\n \"estimatedDeliveryHours\": 1,\n \"allowShowCalendar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping method rates", "description": "Operation ID: GetShippingMethodRates", "request": { "method": "GET", "description": "Operation ID: GetShippingMethodRates\n\nLists one shipping method's rates with zone search and active-state filtering.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods/{id}/rates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods", ":id", "rates" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List shipping method slots", "description": "Operation ID: ListShippingMethodSlots", "request": { "method": "POST", "description": "Operation ID: ListShippingMethodSlots\n\nLists the available time slots for a shipping method on a date.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/methods/slots", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "methods", "slots" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"target\": \"automatic\",\n \"targetId\": \"7204558912004325301\",\n \"postalCode\": \"example_code\",\n \"latitude\": 1,\n \"longitude\": 1,\n \"date\": \"2026-08-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create pickup point", "description": "Operation ID: CreatePickupPoint", "request": { "method": "POST", "description": "Operation ID: CreatePickupPoint\n\nCreates a pickup point where customers can collect their orders.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/pickup-points", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "pickup-points" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"address\": \"example\",\n \"locationId\": \"7204558912004325301\",\n \"connectionId\": \"7204558912004325301\",\n \"isExternal\": false,\n \"externalId\": \"7204558912004325301\",\n \"city\": \"example\",\n \"zone\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List pickup points", "description": "Operation ID: getV1ShippingPickupPoints", "request": { "method": "GET", "description": "Operation ID: getV1ShippingPickupPoints\n\nLists pickup points with name search and active, location, city, or neighborhood filters.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/pickup-points", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "pickup-points" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "city", "value": "example", "disabled": true }, { "key": "zone", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "Get a pickup point by ID", "description": "Operation ID: GetPickupPoint", "request": { "method": "GET", "description": "Operation ID: GetPickupPoint\n\nReturns one pickup point with its address and opening hours.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/pickup-points/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "pickup-points", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update pickup point", "description": "Operation ID: UpdatePickupPoint", "request": { "method": "PUT", "description": "Operation ID: UpdatePickupPoint\n\nUpdates a pickup point's address, contact, instructions, timing, schedule, external reference, and linked location.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/pickup-points/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "pickup-points", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"address\": \"example\",\n \"description\": \"Example description.\",\n \"state\": \"example\",\n \"city\": \"example\",\n \"neighborhood\": \"example\",\n \"postalCode\": \"example_code\",\n \"addressNumber\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create shipping profile", "description": "Operation ID: CreateShippingProfile", "request": { "method": "POST", "description": "Operation ID: CreateShippingProfile\n\nCreate shipping profile. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/profiles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "profiles" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"locationIds\": [\n \"example\"\n ],\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping profiles", "description": "Operation ID: ListShippingProfiles", "request": { "method": "GET", "description": "Operation ID: ListShippingProfiles\n\nList shipping profiles. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/profiles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "profiles" ], "query": [], "variable": [] } } }, { "name": "Delete shipping profile", "description": "Operation ID: DeleteShippingProfile", "request": { "method": "DELETE", "description": "Operation ID: DeleteShippingProfile\n\nDelete shipping profile. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/profiles/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "profiles", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get shipping profile", "description": "Operation ID: GetShippingProfile", "request": { "method": "GET", "description": "Operation ID: GetShippingProfile\n\nGet shipping profile. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/profiles/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "profiles", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update shipping profile", "description": "Operation ID: UpdateShippingProfile", "request": { "method": "PUT", "description": "Operation ID: UpdateShippingProfile\n\nUpdate shipping profile. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/profiles/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "profiles", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"locationIds\": [\n \"example\"\n ],\n \"isDefault\": false,\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create shipping rate", "description": "Operation ID: CreateShippingRate", "request": { "method": "POST", "description": "Operation ID: CreateShippingRate\n\nCreates a rate for a shipping method with optional zone or postal-code matching, order-price and weight limits, and a type-specific price formula.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"type\": \"flat\",\n \"zoneCode\": \"example_code\",\n \"price\": 1,\n \"currency\": \"PEN\",\n \"minOrderPrice\": 1,\n \"maxOrderPrice\": 1,\n \"postalCodes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping rates", "description": "Operation ID: ListShippingRates", "request": { "method": "GET", "description": "Operation ID: ListShippingRates\n\nLists shipping rates with zone search and method, type, or active-state filters.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates" ], "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": "shippingMethodId", "value": "7204558912004325301", "disabled": true }, { "key": "isActive", "value": "false", "description": "Only active items.", "disabled": true }, { "key": "type", "value": "flat", "description": "Only this type.", "disabled": true } ], "variable": [] } } }, { "name": "Delete shipping rate", "description": "Operation ID: DeleteShippingRate", "request": { "method": "DELETE", "description": "Operation ID: DeleteShippingRate\n\nDeletes a shipping rate owned by the current store or seller.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get shipping rate", "description": "Operation ID: GetShippingRate", "request": { "method": "GET", "description": "Operation ID: GetShippingRate\n\nReturns one shipping rate with its zone, pricing formula, limits, postal codes, tax, and surcharge.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update shipping rate", "description": "Operation ID: UpdateShippingRate", "request": { "method": "PUT", "description": "Operation ID: UpdateShippingRate\n\nUpdates a shipping rate's zone, pricing formula, limits, postal codes, tax, surcharge, and active state.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"type\": \"flat\",\n \"zoneCode\": \"example_code\",\n \"price\": 1,\n \"currency\": \"PEN\",\n \"minOrderPrice\": 1,\n \"maxOrderPrice\": 1,\n \"postalCodes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List available shipping rates", "description": "Operation ID: ListAvailableShippingRates", "request": { "method": "POST", "description": "Operation ID: ListAvailableShippingRates\n\nList available shipping rates. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/available", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", "available" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"orderAmount\": 1,\n \"postalCode\": \"example_code\",\n \"totalWeight\": 1,\n \"sellerId\": \"7204558912004325301\",\n \"shippingProfileId\": \"7204558912004325301\",\n \"destination\": {\n \"address1\": \"example\",\n \"city\": \"example\",\n \"countryCode\": \"PE\",\n \"name\": \"Example resource\",\n \"company\": \"example\",\n \"address2\": \"example\",\n \"province\": \"example\",\n \"postalCode\": \"example_code\"\n },\n \"items\": [\n {\n \"sku\": \"SKU-001\",\n \"name\": \"Example resource\",\n \"brand\": \"example\",\n \"weight\": 1,\n \"price\": 1,\n \"quantity\": 1,\n \"height\": 1,\n \"width\": 1,\n \"length\": 1\n }\n ],\n \"scheduledDate\": \"2026-08-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import shipping rates", "description": "Operation ID: postV1ShippingRatesImport", "request": { "method": "POST", "description": "Operation ID: postV1ShippingRatesImport\n\nImports shipping rates in bulk, from an uploaded file or from rows sent inline.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", "import" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"assetId\": \"7204558912004325301\",\n \"rows\": [\n {\n \"action\": \"create\",\n \"shippingRateId\": \"7204558912004325301\",\n \"shippingMethodId\": \"7204558912004325301\",\n \"type\": \"example\",\n \"zoneCode\": \"example_code\",\n \"price\": \"example\",\n \"currency\": \"PEN\",\n \"minOrderPrice\": \"example\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get live shipping quotes", "description": "Operation ID: GetLiveShippingQuotes", "request": { "method": "POST", "description": "Operation ID: GetLiveShippingQuotes\n\nRequests rates from the carrier connected to the selected shipping method for the destination, products, order amount, and currency.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/live-quotes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", "live-quotes" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"countryIsoCode\": \"example_code\",\n \"destination\": {\n \"addressLine\": \"example\",\n \"number\": \"example\",\n \"postalCode\": \"example_code\",\n \"department\": \"example\",\n \"province\": \"example\",\n \"district\": \"example\",\n \"reference\": \"example\",\n \"latitude\": 1\n },\n \"products\": [\n {\n \"sku\": \"SKU-001\",\n \"name\": \"Example resource\",\n \"brand\": \"example\",\n \"weight\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"height\": 0,\n \"width\": 0\n }\n ],\n \"orderAmount\": 1,\n \"currency\": \"PEN\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download shipping rates import template", "description": "Operation ID: DownloadShippingRatesTemplate", "request": { "method": "GET", "description": "Operation ID: DownloadShippingRatesTemplate\n\nDownloads the spreadsheet template for importing shipping rates.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/rates/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "rates", "template" ], "query": [], "variable": [] } } }, { "name": "Get shipping settings", "description": "Operation ID: GetShippingSettings", "request": { "method": "GET", "description": "Operation ID: GetShippingSettings\n\nGet shipping settings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "settings" ], "query": [], "variable": [] } } }, { "name": "Update shipping settings", "description": "Operation ID: UpdateShippingSettings", "request": { "method": "PATCH", "description": "Operation ID: UpdateShippingSettings\n\nUpdate shipping settings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "settings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"defaultLocationId\": \"7204558912004325301\",\n \"estimatedDeliveryEnabled\": false,\n \"estimatedDeliveryFulfillmentDays\": 1,\n \"pickupEnabled\": false,\n \"localDeliveryEnabled\": false,\n \"useLiveRates\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create shipping zone", "description": "Operation ID: CreateShippingZone", "request": { "method": "POST", "description": "Operation ID: CreateShippingZone\n\nCreates a shipping zone from country, province, city, district, or postal-code selectors.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/zones", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "zones" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"example_code\",\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"countryCodes\": [\n \"example\"\n ],\n \"provinceCodes\": [\n \"example\"\n ],\n \"cityNames\": [\n \"example\"\n ],\n \"districtNames\": [\n \"example\"\n ],\n \"postalCodes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List shipping zones", "description": "Operation ID: ListShippingZones", "request": { "method": "GET", "description": "Operation ID: ListShippingZones\n\nLists shipping zones with name or code search and active-state filtering.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/zones", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "zones" ], "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": "isActive", "value": "false", "description": "Only active items.", "disabled": true } ], "variable": [] } } }, { "name": "Get shipping zone", "description": "Operation ID: GetShippingZone", "request": { "method": "GET", "description": "Operation ID: GetShippingZone\n\nReturns one shipping zone with its country, province, city, district, and postal-code selectors.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/zones/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "zones", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update shipping zone", "description": "Operation ID: UpdateShippingZone", "request": { "method": "PUT", "description": "Operation ID: UpdateShippingZone\n\nUpdates a shipping zone: the set of areas that share the same rates.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/shipping/zones/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "shipping", "zones", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"example_code\",\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"countryCodes\": [\n \"example\"\n ],\n \"provinceCodes\": [\n \"example\"\n ],\n \"cityNames\": [\n \"example\"\n ],\n \"districtNames\": [\n \"example\"\n ],\n \"postalCodes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create tax override", "description": "Operation ID: CreateTaxOverride", "request": { "method": "POST", "description": "Operation ID: CreateTaxOverride\n\nCreate tax override. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/overrides", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "overrides" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"taxRegionId\": \"7204558912004325301\",\n \"name\": \"Example resource\",\n \"target\": \"products\",\n \"rate\": 1,\n \"isExempt\": false,\n \"collectionId\": \"7204558912004325301\",\n \"categoryId\": \"7204558912004325301\",\n \"productType\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List tax overrides", "description": "Operation ID: ListTaxOverrides", "request": { "method": "GET", "description": "Operation ID: ListTaxOverrides\n\nList tax overrides. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/overrides", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "overrides" ], "query": [], "variable": [] } } }, { "name": "Delete tax override", "description": "Operation ID: DeleteTaxOverride", "request": { "method": "DELETE", "description": "Operation ID: DeleteTaxOverride\n\nDelete tax override. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/overrides/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "overrides", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get tax override", "description": "Operation ID: GetTaxOverride", "request": { "method": "GET", "description": "Operation ID: GetTaxOverride\n\nGet tax override. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/overrides/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "overrides", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update tax override", "description": "Operation ID: UpdateTaxOverride", "request": { "method": "PUT", "description": "Operation ID: UpdateTaxOverride\n\nUpdate tax override. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/overrides/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "overrides", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"taxRegionId\": \"7204558912004325301\",\n \"name\": \"Example resource\",\n \"target\": \"products\",\n \"rate\": 1,\n \"isExempt\": false,\n \"collectionId\": \"7204558912004325301\",\n \"categoryId\": \"7204558912004325301\",\n \"productType\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create tax region", "description": "Operation ID: CreateTaxRegion", "request": { "method": "POST", "description": "Operation ID: CreateTaxRegion\n\nCreate tax region. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/regions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "regions" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"PE\",\n \"name\": \"Example resource\",\n \"serviceType\": \"manual\",\n \"isActive\": false,\n \"rates\": [\n {\n \"provinceCode\": \"example_code\",\n \"provinceName\": \"Example resource\",\n \"rate\": 1,\n \"label\": \"example\",\n \"calculationType\": \"additive\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List tax regions", "description": "Operation ID: ListTaxRegions", "request": { "method": "GET", "description": "Operation ID: ListTaxRegions\n\nList tax regions. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/regions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "regions" ], "query": [], "variable": [] } } }, { "name": "Delete tax region", "description": "Operation ID: DeleteTaxRegion", "request": { "method": "DELETE", "description": "Operation ID: DeleteTaxRegion\n\nDelete tax region. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/regions/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "regions", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get tax region", "description": "Operation ID: GetTaxRegion", "request": { "method": "GET", "description": "Operation ID: GetTaxRegion\n\nGet tax region. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/regions/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "regions", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update tax region", "description": "Operation ID: UpdateTaxRegion", "request": { "method": "PUT", "description": "Operation ID: UpdateTaxRegion\n\nUpdate tax region. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/regions/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "regions", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"PE\",\n \"name\": \"Example resource\",\n \"serviceType\": \"manual\",\n \"isActive\": false,\n \"rates\": [\n {\n \"provinceCode\": \"example_code\",\n \"provinceName\": \"Example resource\",\n \"rate\": 1,\n \"label\": \"example\",\n \"calculationType\": \"additive\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get tax settings", "description": "Operation ID: GetTaxSettings", "request": { "method": "GET", "description": "Operation ID: GetTaxSettings\n\nGet tax settings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "settings" ], "query": [], "variable": [] } } }, { "name": "Update tax settings", "description": "Operation ID: UpdateTaxSettings", "request": { "method": "PUT", "description": "Operation ID: UpdateTaxSettings\n\nUpdate tax settings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/taxes/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "taxes", "settings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"serviceType\": \"manual\",\n \"serviceActive\": false,\n \"pricesIncludeTax\": false,\n \"chargeTaxOnShipping\": false,\n \"chargeVatOnDigitalGoods\": false,\n \"collectDutiesAtCheckout\": false\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inventory", "item": [ { "name": "List inventory levels", "description": "Operation ID: getV1Inventory", "request": { "method": "GET", "description": "Operation ID: getV1Inventory\n\nLists inventory rows by variant and location, including on-hand, committed, unavailable, available, and incoming quantities.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory" ], "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": "inventoryIds", "value": "[1]", "disabled": true }, { "key": "locationIds", "value": "[1]", "disabled": true }, { "key": "brandIds", "value": "[1]", "description": "Only items of these brands.", "disabled": true }, { "key": "categoryIds", "value": "[1]", "description": "Only items in these categories.", "disabled": true }, { "key": "productStatus", "value": "[\"draft\"]", "disabled": true }, { "key": "minOnHand", "value": "1", "description": "Minimum stock on hand.", "disabled": true }, { "key": "maxOnHand", "value": "1", "description": "Maximum stock on hand.", "disabled": true }, { "key": "minAvailable", "value": "1", "description": "Minimum stock available to sell.", "disabled": true }, { "key": "maxAvailable", "value": "1", "disabled": true }, { "key": "minCommitted", "value": "1", "disabled": true }, { "key": "maxCommitted", "value": "1", "disabled": true }, { "key": "isLowStock", "value": "false", "disabled": true }, { "key": "isInStock", "value": "false", "disabled": true }, { "key": "trackInventory", "value": "false", "disabled": true }, { "key": "includeTotalCount", "value": "false", "description": "Include the total number of matches. Slower on large catalogs.", "disabled": true } ], "variable": [] } } }, { "name": "Set or adjust inventory stock", "description": "Operation ID: postV1InventoryAdjust", "request": { "method": "POST", "description": "Operation ID: postV1InventoryAdjust\n\nSets or adjusts a variant's on-hand or available quantity at a location and records the reason. ExpectedVersion 0 asserts that no level exists yet; a positive value must match the current level version.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/adjust", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "adjust" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"variantId\": \"7204558912004325377\",\n \"locationId\": \"7204558912004325378\",\n \"target\": \"onHand\",\n \"mode\": \"adjust\",\n \"quantity\": 5,\n \"reason\": \"restock\",\n \"note\": \"Ingreso de cinco unidades.\",\n \"expectedVersion\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List available inventory quantities", "description": "Operation ID: ListInventoryAvailability", "request": { "method": "POST", "description": "Operation ID: ListInventoryAvailability\n\nReturns the available quantity for each requested variant and location with an inventory level.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/availability", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "availability" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"example\"\n ],\n \"variantIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update stock in bulk", "description": "Operation ID: postV1InventoryBatchStock", "request": { "method": "POST", "description": "Operation ID: postV1InventoryBatchStock\n\nQueues asynchronous set-or-adjust stock updates for multiple variant and location rows. ExpectedVersion 0 asserts that a row does not exist yet; a positive value must match its current version.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/batch/stock", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "batch", "stock" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"variantId\": \"7204558912004325301\",\n \"locationId\": \"7204558912004325301\",\n \"mode\": \"set\",\n \"quantity\": 1,\n \"expectedVersion\": 1\n }\n ],\n \"reason\": \"inventoryCount\",\n \"note\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consume committed inventory stock", "description": "Operation ID: ConsumeReservedInventory", "request": { "method": "POST", "description": "Operation ID: ConsumeReservedInventory\n\nDecreases committed and on-hand stock for the requested variants at a location.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/consume-reserved", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "consume-reserved" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"locationId\": \"7204558912004325301\",\n \"locationName\": \"Example resource\",\n \"lines\": [\n {\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"productName\": \"Example resource\",\n \"variantName\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1\n }\n ],\n \"note\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Count inventory items", "description": "Operation ID: getV1InventoryCount", "request": { "method": "GET", "description": "Operation ID: getV1InventoryCount\n\nReturns how many inventory items match a filter, without returning them.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "count" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "inventoryIds", "value": "[1]", "disabled": true }, { "key": "locationIds", "value": "[1]", "disabled": true }, { "key": "brandIds", "value": "[1]", "description": "Only items of these brands.", "disabled": true }, { "key": "categoryIds", "value": "[1]", "description": "Only items in these categories.", "disabled": true }, { "key": "productStatus", "value": "[\"draft\"]", "disabled": true }, { "key": "minOnHand", "value": "1", "description": "Minimum stock on hand.", "disabled": true }, { "key": "maxOnHand", "value": "1", "description": "Maximum stock on hand.", "disabled": true }, { "key": "minAvailable", "value": "1", "description": "Minimum stock available to sell.", "disabled": true }, { "key": "maxAvailable", "value": "1", "disabled": true }, { "key": "minCommitted", "value": "1", "disabled": true }, { "key": "maxCommitted", "value": "1", "disabled": true }, { "key": "isInStock", "value": "false", "disabled": true } ], "variable": [] } } }, { "name": "Export inventory", "description": "Operation ID: postV1InventoryExports", "request": { "method": "POST", "description": "Operation ID: postV1InventoryExports\n\nQueues an inventory export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"locationIds\": [\n \"example\"\n ],\n \"brandIds\": [\n \"example\"\n ],\n \"categoryIds\": [\n \"example\"\n ],\n \"productStatus\": [\n \"draft\"\n ],\n \"minOnHand\": 1,\n \"maxOnHand\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import versioned inventory", "description": "Operation ID: ImportInventory", "request": { "method": "POST", "description": "Operation ID: ImportInventory\n\nQueues a CSV, TSV, or XLSX inventory import previously uploaded as an immutable asset.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "import" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"clientRunId\": \"7204558912004325301\",\n \"assetId\": \"7204558912004325301\",\n \"checksum\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload import file", "description": "Operation ID: UploadInventoryImportAsset", "request": { "method": "POST", "description": "Operation ID: UploadInventoryImportAsset\n\nUploads the raw CSV, TSV, or XLSX source consumed by an inventory import.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/import-assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "import-assets" ], "query": [ { "key": "fileName", "value": "Example resource", "description": "Name of the file.", "disabled": false } ], "variable": [] }, "body": { "mode": "file", "file": { "src": "./inventario.csv" } } } }, { "name": "List inventory levels", "description": "Operation ID: ListInventoryLevels", "request": { "method": "POST", "description": "Operation ID: ListInventoryLevels\n\nReturns per-location inventory levels for the requested variants, including on-hand, committed, unavailable, available, and incoming quantities.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/levels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "levels" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"variantIds\": [\n \"example\"\n ],\n \"locationIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Release committed inventory stock", "description": "Operation ID: ReleaseInventory", "request": { "method": "POST", "description": "Operation ID: ReleaseInventory\n\nDecreases committed stock for the requested variants, returning the quantity to available stock without changing on-hand stock.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/release", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "release" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"locationId\": \"7204558912004325301\",\n \"lines\": [\n {\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"productName\": \"Example resource\",\n \"variantName\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Commit inventory stock", "description": "Operation ID: ReserveInventory", "request": { "method": "POST", "description": "Operation ID: ReserveInventory\n\nIncreases committed stock for the requested variants at a location, reducing their available quantity.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "reserve" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"locationId\": \"7204558912004325301\",\n \"lines\": [\n {\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"productName\": \"Example resource\",\n \"variantName\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List stock totals", "description": "Operation ID: ListInventoryTotals", "request": { "method": "POST", "description": "Operation ID: ListInventoryTotals\n\nReturns stock totals across locations, without the per-location breakdown.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/totals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "totals" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"variantIds\": [\n \"example\"\n ],\n \"locationIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List inventory transactions", "description": "Operation ID: getV1InventoryTransactions", "request": { "method": "GET", "description": "Operation ID: getV1InventoryTransactions\n\nReturns the ledger of stock movements: what moved, when, why and by how much.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/inventory/transactions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "inventory", "transactions" ], "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": "productId", "value": "7204558912004325301", "description": "Identifier of the product.", "disabled": true }, { "key": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant.", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "reason", "value": "inventoryCount", "description": "Reason recorded with the action.", "disabled": true }, { "key": "referenceId", "value": "7204558912004325301", "disabled": true }, { "key": "fromDate", "value": "2026-08-01T15:30:00Z", "description": "Start of the date range, inclusive.", "disabled": true }, { "key": "toDate", "value": "2026-08-01T15:30:00Z", "description": "End of the date range, inclusive.", "disabled": true } ], "variable": [] } } } ] }, { "name": "Orders", "item": [ { "name": "List carts", "description": "Operation ID: ListCarts", "request": { "method": "GET", "description": "Operation ID: ListCarts\n\nList carts. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts" ], "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": "status", "value": "[\"inProgress\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "email", "value": "andrea@example.com", "disabled": true } ], "variable": [] } } }, { "name": "Get cart", "description": "Operation ID: GetCart", "request": { "method": "GET", "description": "Operation ID: GetCart\n\nGet cart. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/{cartId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", ":cartId" ], "query": [], "variable": [ { "key": "cartId", "value": "7204558912004325301" } ] } } }, { "name": "Get recovery stats", "description": "Operation ID: GetCartRecoveryStats", "request": { "method": "GET", "description": "Operation ID: GetCartRecoveryStats\n\nGet recovery stats. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/carts/recovery-stats", "host": [ "{{baseUrl}}" ], "path": [ "v1", "carts", "recovery-stats" ], "query": [], "variable": [] } } }, { "name": "Create order bump", "description": "Operation ID: postV1OrderBumps", "request": { "method": "POST", "description": "Operation ID: postV1OrderBumps\n\nCreate order bump. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-bumps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-bumps" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"offerPrice\": 1,\n \"minimumCartSubtotal\": 1,\n \"priority\": 1,\n \"maxPerCart\": 1,\n \"startsAt\": \"2026-08-01T15:30:00Z\",\n \"endsAt\": \"2026-08-01T15:30:00Z\",\n \"badgeLabel\": \"example\",\n \"callToAction\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order bumps", "description": "Operation ID: getV1OrderBumps", "request": { "method": "GET", "description": "Operation ID: getV1OrderBumps\n\nList order bumps. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-bumps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-bumps" ], "query": [], "variable": [] } } }, { "name": "Delete order bump", "description": "Operation ID: deleteV1OrderBumpsOrderBumpId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1OrderBumpsOrderBumpId\n\nDelete order bump. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-bumps/{orderBumpId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-bumps", ":orderBumpId" ], "query": [], "variable": [ { "key": "orderBumpId", "value": "7204558912004325301", "description": "Identifier of the order bump." } ] } } }, { "name": "Get order bump", "description": "Operation ID: getV1OrderBumpsOrderBumpId", "request": { "method": "GET", "description": "Operation ID: getV1OrderBumpsOrderBumpId\n\nGet order bump. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-bumps/{orderBumpId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-bumps", ":orderBumpId" ], "query": [], "variable": [ { "key": "orderBumpId", "value": "7204558912004325301", "description": "Identifier of the order bump." } ] } } }, { "name": "Update order bump", "description": "Operation ID: putV1OrderBumpsOrderBumpId", "request": { "method": "PUT", "description": "Operation ID: putV1OrderBumpsOrderBumpId\n\nUpdate order bump. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-bumps/{orderBumpId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-bumps", ":orderBumpId" ], "query": [], "variable": [ { "key": "orderBumpId", "value": "7204558912004325301", "description": "Identifier of the order bump." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"offerPrice\": 1,\n \"minimumCartSubtotal\": 1,\n \"priority\": 1,\n \"maxPerCart\": 1,\n \"startsAt\": \"2026-08-01T15:30:00Z\",\n \"endsAt\": \"2026-08-01T15:30:00Z\",\n \"badgeLabel\": \"example\",\n \"callToAction\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create order draft", "description": "Operation ID: CreateOrderDraft", "request": { "method": "POST", "description": "Operation ID: CreateOrderDraft\n\nCreate order draft. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"PEN\",\n \"customerId\": \"7204558912004325301\",\n \"cartId\": \"7204558912004325301\",\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 \"source\": \"example\",\n \"notes\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order drafts", "description": "Operation ID: ListOrderDrafts", "request": { "method": "GET", "description": "Operation ID: ListOrderDrafts\n\nList order drafts. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts" ], "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": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource.", "disabled": true }, { "key": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer.", "disabled": true } ], "variable": [] } } }, { "name": "Get order draft", "description": "Operation ID: GetOrderDraft", "request": { "method": "GET", "description": "Operation ID: GetOrderDraft\n\nGet order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] } } }, { "name": "Update order draft", "description": "Operation ID: UpdateOrderDraft", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderDraft\n\nUpdate order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"customerId\": \"7204558912004325301\",\n \"cartId\": \"7204558912004325301\",\n \"email\": \"andrea@example.com\",\n \"phone\": \"+51987654321\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"identificationType\": \"example\",\n \"identificationNumber\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel order draft", "description": "Operation ID: CancelOrderDraft", "request": { "method": "POST", "description": "Operation ID: CancelOrderDraft\n\nCancel order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "cancel" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Convert order draft to order", "description": "Operation ID: ConvertOrderDraftToOrder", "request": { "method": "POST", "description": "Operation ID: ConvertOrderDraftToOrder\n\nConvert order draft to order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/convert", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "convert" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"invoiceType\": \"ticket\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add item to order draft", "description": "Operation ID: AddItemToOrderDraft", "request": { "method": "POST", "description": "Operation ID: AddItemToOrderDraft\n\nAdd item to order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "items" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"catalogVariant\",\n \"quantity\": 1,\n \"variantId\": \"7204558912004325301\",\n \"title\": \"Example title\",\n \"subtitle\": \"Example title\",\n \"thumbnail\": \"example\",\n \"unitPrice\": 1,\n \"discount\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove item from order draft", "description": "Operation ID: RemoveItemFromOrderDraft", "request": { "method": "DELETE", "description": "Operation ID: RemoveItemFromOrderDraft\n\nRemove item from order draft. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/items/{itemId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "items", ":itemId" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] } } }, { "name": "Update order draft item", "description": "Operation ID: UpdateOrderDraftItem", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderDraftItem\n\nUpdate order draft item. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/items/{itemId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "items", ":itemId" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"unitPrice\": 1,\n \"discount\": 1,\n \"shipping\": 1,\n \"tax\": 1,\n \"warranty\": 1,\n \"requiresShipping\": false,\n \"isTaxInclusive\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create order draft share link", "description": "Operation ID: CreateOrderDraftShareLink", "request": { "method": "POST", "description": "Operation ID: CreateOrderDraftShareLink\n\nCreate order draft share link. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/share", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "share" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"shareExpiresAt\": \"2026-08-01T15:30:00Z\",\n \"allowAnonymousShareAccess\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear order draft shipping method", "description": "Operation ID: ClearOrderDraftShippingMethod", "request": { "method": "DELETE", "description": "Operation ID: ClearOrderDraftShippingMethod\n\nClear order draft shipping method. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/shipping-method", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "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": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] } } }, { "name": "Set order draft shipping method", "description": "Operation ID: SetOrderDraftShippingMethod", "request": { "method": "PUT", "description": "Operation ID: SetOrderDraftShippingMethod\n\nSet order draft shipping method. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/shipping-method", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "shipping-method" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingMethodId\": \"7204558912004325301\",\n \"target\": \"automatic\",\n \"sellerId\": \"7204558912004325301\",\n \"shippingProfileId\": \"7204558912004325301\",\n \"rateId\": \"7204558912004325301\",\n \"targetId\": \"7204558912004325301\",\n \"scheduledDate\": \"2026-08-01\",\n \"scheduledTime\": \"09:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order draft shipping options", "description": "Operation ID: ListOrderDraftShippingOptions", "request": { "method": "GET", "description": "Operation ID: ListOrderDraftShippingOptions\n\nList order draft shipping options. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/shipping-options", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "shipping-options" ], "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": "scheduledDate", "value": "2026-08-01", "disabled": true }, { "key": "scheduledTime", "value": "09:00:00Z", "disabled": true } ], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] } } }, { "name": "Update order draft status", "description": "Operation ID: UpdateOrderDraftStatus", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderDraftStatus\n\nUpdate order draft status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/order-drafts/{draftId}/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "order-drafts", ":draftId", "status" ], "query": [], "variable": [ { "key": "draftId", "value": "7204558912004325301", "description": "Identifier of the order draft." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List orders", "description": "Operation ID: ListOrders", "request": { "method": "GET", "description": "Operation ID: ListOrders\n\nList orders. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "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 }, { "key": "status", "value": "[\"new\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "state", "value": "[\"open\"]", "disabled": true }, { "key": "fulfillmentStatus", "value": "[\"unfulfilled\"]", "disabled": true }, { "key": "returnStatus", "value": "[\"none\"]", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "orderShortId", "value": "7204558912004325301", "disabled": true }, { "key": "paymentCodes", "value": "[\"example\"]", "disabled": true }, { "key": "sources", "value": "[\"example\"]", "disabled": true }, { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer.", "disabled": true }, { "key": "conciliated", "value": "false", "disabled": true }, { "key": "dateFrom", "value": "2026-08-01T15:30:00Z", "disabled": true }, { "key": "dateTo", "value": "2026-08-01T15:30:00Z", "disabled": true } ], "variable": [] } } }, { "name": "Get order", "description": "Operation ID: GetOrder", "request": { "method": "GET", "description": "Operation ID: GetOrder\n\nGet order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId" ], "query": [ { "key": "include", "value": "example", "disabled": true } ], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "List order activity", "description": "Operation ID: ListOrderActivity", "request": { "method": "GET", "description": "Operation ID: ListOrderActivity\n\nList order activity. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "activity" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Cancel order", "description": "Operation ID: CancelOrder", "request": { "method": "POST", "description": "Operation ID: CancelOrder\n\nCancel order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "cancel" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"cancelReason\": \"Example note.\",\n \"cancelReasonType\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create order claim", "description": "Operation ID: CreateOrderClaim", "request": { "method": "POST", "description": "Operation ID: CreateOrderClaim\n\nCreate order claim. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/claims", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "claims" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"claim\",\n \"subject\": \"example\",\n \"description\": \"Example description.\",\n \"contactEmail\": \"andrea@example.com\",\n \"contactPhone\": \"+51987654321\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Close order", "description": "Operation ID: CloseOrder", "request": { "method": "POST", "description": "Operation ID: CloseOrder\n\nClose order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/close", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "close" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Add order comment", "description": "Operation ID: AddOrderComment", "request": { "method": "POST", "description": "Operation ID: AddOrderComment\n\nAdd order comment. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/comments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "comments" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"example\",\n \"attachmentUrls\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm order", "description": "Operation ID: ConfirmOrder", "request": { "method": "POST", "description": "Operation ID: ConfirmOrder\n\nConfirm order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/confirm", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "confirm" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Add order custom status", "description": "Operation ID: AddOrderCustomStatus", "request": { "method": "POST", "description": "Operation ID: AddOrderCustomStatus\n\nAdd order custom status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/custom-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "custom-status" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"example\",\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deliver order", "description": "Operation ID: DeliverOrder", "request": { "method": "POST", "description": "Operation ID: DeliverOrder\n\nDeliver order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/delivery", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "delivery" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set order in progress", "description": "Operation ID: SetOrderInProgress", "request": { "method": "POST", "description": "Operation ID: SetOrderInProgress\n\nSet order in progress. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/in-progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "in-progress" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set order in transit", "description": "Operation ID: SetOrderInTransit", "request": { "method": "POST", "description": "Operation ID: SetOrderInTransit\n\nSet order in transit. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/in-transit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "in-transit" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invalidate order", "description": "Operation ID: InvalidateOrder", "request": { "method": "POST", "description": "Operation ID: InvalidateOrder\n\nInvalidate order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "invalidate" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Invoice order", "description": "Operation ID: InvoiceOrder", "request": { "method": "POST", "description": "Operation ID: InvoiceOrder\n\nInvoice order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "invoice" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"invoiceNumber\": \"example\",\n \"invoiceLink\": \"example\",\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel order item", "description": "Operation ID: CancelOrderItem", "request": { "method": "POST", "description": "Operation ID: CancelOrderItem\n\nCancel order item. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/items/{itemId}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "items", ":itemId", "cancel" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"cancelReason\": \"Example note.\",\n \"cancelReasonType\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deliver order item", "description": "Operation ID: DeliverOrderItem", "request": { "method": "POST", "description": "Operation ID: DeliverOrderItem\n\nDeliver order item. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/items/{itemId}/delivery", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "items", ":itemId", "delivery" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set order item in transit", "description": "Operation ID: SetOrderItemInTransit", "request": { "method": "POST", "description": "Operation ID: SetOrderItemInTransit\n\nSet order item in transit. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/items/{itemId}/in-transit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "items", ":itemId", "in-transit" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invoice order item", "description": "Operation ID: InvoiceOrderItem", "request": { "method": "POST", "description": "Operation ID: InvoiceOrderItem\n\nInvoice order item. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/items/{itemId}/invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "items", ":itemId", "invoice" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"invoiceNumber\": \"example\",\n \"invoiceLink\": \"example\",\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Return order item", "description": "Operation ID: ReturnOrderItem", "request": { "method": "POST", "description": "Operation ID: ReturnOrderItem\n\nReturn order item. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/items/{itemId}/return", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "items", ":itemId", "return" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." }, { "key": "itemId", "value": "7204558912004325301", "description": "Identifier of the item." } ] }, "body": { "mode": "raw", "raw": "{\n \"idempotencyKey\": \"example\",\n \"quantity\": 1,\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"comment\": \"example\",\n \"evidenceUrls\": [\n \"example\"\n ],\n \"restock\": false,\n \"restockLocationId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order notes", "description": "Operation ID: UpdateOrderNotes", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderNotes\n\nUpdate order notes. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "notes" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"notes\": \"Example note.\",\n \"userAssigned\": \"example\",\n \"expectedUpdatedOn\": \"2026-08-01T15:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set order package status", "description": "Operation ID: SetOrderPackageStatus", "request": { "method": "POST", "description": "Operation ID: SetOrderPackageStatus\n\nSet order package status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/package-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "package-status" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"trackingNumber\": \"example\",\n \"state\": \"inTransit\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order packages", "description": "Operation ID: ListOrderPackages", "request": { "method": "GET", "description": "Operation ID: ListOrderPackages\n\nList order packages. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/packages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "packages" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Set order ready to pick up", "description": "Operation ID: SetOrderReadyToPickUp", "request": { "method": "POST", "description": "Operation ID: SetOrderReadyToPickUp\n\nSet order ready to pick up. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/ready-to-pickup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "ready-to-pickup" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\",\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Return order", "description": "Operation ID: ReturnOrder", "request": { "method": "POST", "description": "Operation ID: ReturnOrder\n\nReturn order. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/return", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "return" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"idempotencyKey\": \"example\",\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"comment\": \"example\",\n \"evidenceUrls\": [\n \"example\"\n ],\n \"restock\": false,\n \"restockLocationId\": \"7204558912004325301\",\n \"refundAmount\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order return status", "description": "Operation ID: UpdateOrderReturnStatus", "request": { "method": "PUT", "description": "Operation ID: UpdateOrderReturnStatus\n\nUpdate order return status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/return-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "return-status" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"none\",\n \"comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order tags", "description": "Operation ID: UpdateOrderTags", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderTags\n\nUpdate order tags. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "tags" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] }, "body": { "mode": "raw", "raw": "{\n \"tags\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order transactions", "description": "Operation ID: ListOrderTransactions", "request": { "method": "GET", "description": "Operation ID: ListOrderTransactions\n\nList order transactions. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/{orderId}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", ":orderId", "transactions" ], "query": [], "variable": [ { "key": "orderId", "value": "7204558912004325301", "description": "Identifier of the order." } ] } } }, { "name": "Create orders", "description": "Operation ID: CreateOrders", "request": { "method": "POST", "description": "Operation ID: CreateOrders\n\nCreate orders. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/batch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "batch" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"orders\": [\n {\n \"cartId\": \"7204558912004325301\",\n \"currencyCode\": \"PEN\",\n \"shippingAddress\": {\n \"address1\": \"example\",\n \"city\": \"example\",\n \"countryCode\": \"PE\",\n \"name\": \"Example resource\",\n \"company\": \"example\",\n \"address2\": \"example\",\n \"province\": \"example\",\n \"postalCode\": \"example_code\"\n },\n \"billingAddress\": {\n \"address1\": \"example\",\n \"city\": \"example\",\n \"countryCode\": \"PE\",\n \"name\": \"Example resource\",\n \"company\": \"example\",\n \"address2\": \"example\",\n \"province\": \"example\",\n \"postalCode\": \"example_code\"\n },\n \"id\": \"7204558912004325301\",\n \"orderNumber\": \"ORD-2026-0001\",\n \"orderGroup\": \"example\",\n \"sellerId\": \"7204558912004325301\"\n }\n ],\n \"paymentRequest\": {\n \"paymentMethodCode\": \"example_code\",\n \"externalRef\": \"example\",\n \"receiptUrl\": \"https://example.com/resource\",\n \"token\": \"replace_with_the_issued_token\",\n \"providerPaymentMethodId\": \"7204558912004325301\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch update order conciliation", "description": "Operation ID: BatchUpdateOrderConciliation", "request": { "method": "PATCH", "description": "Operation ID: BatchUpdateOrderConciliation\n\nBatch update order conciliation. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/batch/conciliation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "batch", "conciliation" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"orderIds\": [\n \"example\"\n ],\n \"orderNumbers\": [\n \"example\"\n ],\n \"conciliated\": false,\n \"conciliationAt\": \"2026-08-01T15:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order claims", "description": "Operation ID: ListOrderClaims", "request": { "method": "GET", "description": "Operation ID: ListOrderClaims\n\nList order claims. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/claims", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "claims" ], "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": "orderId", "value": "7204558912004325301", "description": "Identifier of the order.", "disabled": true }, { "key": "status", "value": "open", "description": "Only items in these statuses.", "disabled": true }, { "key": "type", "value": "claim", "description": "Only this type.", "disabled": true } ], "variable": [] } } }, { "name": "Get order claim", "description": "Operation ID: GetOrderClaim", "request": { "method": "GET", "description": "Operation ID: GetOrderClaim\n\nGet order claim. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/claims/{claimId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "claims", ":claimId" ], "query": [], "variable": [ { "key": "claimId", "value": "7204558912004325301", "description": "Identifier of the claim." } ] } } }, { "name": "Add order claim note", "description": "Operation ID: AddOrderClaimNote", "request": { "method": "POST", "description": "Operation ID: AddOrderClaimNote\n\nAdd order claim note. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/claims/{claimId}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "claims", ":claimId", "notes" ], "query": [], "variable": [ { "key": "claimId", "value": "7204558912004325301", "description": "Identifier of the claim." } ] }, "body": { "mode": "raw", "raw": "{\n \"note\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order claim status", "description": "Operation ID: UpdateOrderClaimStatus", "request": { "method": "PATCH", "description": "Operation ID: UpdateOrderClaimStatus\n\nUpdate order claim status. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/claims/{claimId}/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "claims", ":claimId", "status" ], "query": [], "variable": [ { "key": "claimId", "value": "7204558912004325301", "description": "Identifier of the claim." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"resolution\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get customer order preferences", "description": "Operation ID: GetCustomerOrderPreferences", "request": { "method": "GET", "description": "Operation ID: GetCustomerOrderPreferences\n\nGet customer order preferences. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/customer-preferences/{customerId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "customer-preferences", ":customerId" ], "query": [], "variable": [ { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer." } ] } } }, { "name": "Export orders", "description": "Operation ID: postV1OrdersExports", "request": { "method": "POST", "description": "Operation ID: postV1OrdersExports\n\nQueues an order export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"statuses\": [\n \"new\"\n ],\n \"states\": [\n \"open\"\n ],\n \"fulfillmentStatuses\": [\n \"unfulfilled\"\n ],\n \"returnStatuses\": [\n \"none\"\n ],\n \"itemStatuses\": [\n \"new\"\n ],\n \"paymentCodes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get orders by group", "description": "Operation ID: GetOrdersByGroup", "request": { "method": "GET", "description": "Operation ID: GetOrdersByGroup\n\nGet orders by group. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/group/{orderGroup}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "group", ":orderGroup" ], "query": [], "variable": [ { "key": "orderGroup", "value": "example" } ] } } }, { "name": "Upload import file", "description": "Operation ID: UploadOrderImportAsset", "request": { "method": "POST", "description": "Operation ID: UploadOrderImportAsset\n\nUpload import file. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/import-assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "import-assets" ], "query": [ { "key": "fileName", "value": "Example resource", "description": "Name of the file.", "disabled": false } ], "variable": [] }, "body": { "mode": "file", "file": { "src": "./pedidos.csv" } } } }, { "name": "Get import schema", "description": "Operation ID: GetOrderImportSchema", "request": { "method": "GET", "description": "Operation ID: GetOrderImportSchema\n\nGet import schema. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/import-schema", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "import-schema" ], "query": [], "variable": [] } } }, { "name": "Download import template", "description": "Operation ID: DownloadOrderImportTemplate", "request": { "method": "GET", "description": "Operation ID: DownloadOrderImportTemplate\n\nDownload import template. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/import-template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "import-template" ], "query": [], "variable": [] } } }, { "name": "Import validated order", "description": "Operation ID: ImportOrders", "request": { "method": "POST", "description": "Operation ID: ImportOrders\n\nImport validated order. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/imports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "imports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"clientRunId\": \"7204558912004325301\",\n \"assetId\": \"7204558912004325301\",\n \"checksum\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Preview order import", "description": "Operation ID: PreviewOrderImport", "request": { "method": "POST", "description": "Operation ID: PreviewOrderImport\n\nPreview order import. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/imports/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "imports", "preview" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"assetId\": \"7204558912004325301\",\n \"checksum\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order items", "description": "Operation ID: ListOrderItems", "request": { "method": "GET", "description": "Operation ID: ListOrderItems\n\nList order items. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "items" ], "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": "status", "value": "[\"new\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "state", "value": "[\"open\"]", "disabled": true }, { "key": "fulfillmentStatus", "value": "[\"unfulfilled\"]", "disabled": true }, { "key": "returnStatus", "value": "[\"none\"]", "disabled": true }, { "key": "itemStatus", "value": "[\"new\"]", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "orderIds", "value": "[\"example\"]", "disabled": true }, { "key": "itemIds", "value": "[\"example\"]", "disabled": true }, { "key": "paymentCodes", "value": "[\"example\"]", "disabled": true }, { "key": "sources", "value": "[\"example\"]", "disabled": true }, { "key": "customerId", "value": "7204558912004325301", "description": "Identifier of the customer.", "disabled": true }, { "key": "conciliated", "value": "false", "disabled": true }, { "key": "dateFrom", "value": "2026-08-01T15:30:00Z", "disabled": true }, { "key": "dateTo", "value": "2026-08-01T15:30:00Z", "disabled": true } ], "variable": [] } } }, { "name": "Save order item spreadsheet", "description": "Operation ID: SaveOrderItemSpreadsheet", "request": { "method": "POST", "description": "Operation ID: SaveOrderItemSpreadsheet\n\nSave order item spreadsheet. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/items/spreadsheet/save", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "items", "spreadsheet", "save" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"orderId\": \"7204558912004325301\",\n \"itemId\": \"7204558912004325301\",\n \"targetStatus\": \"example\",\n \"invoiceChanged\": false,\n \"trackingChanged\": false,\n \"invoice\": {\n \"invoiceNumber\": \"example\",\n \"invoiceLink\": \"example\",\n \"comment\": \"example\"\n },\n \"tracking\": {\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Count scheduled orders", "description": "Operation ID: GetOrderScheduleCount", "request": { "method": "POST", "description": "Operation ID: GetOrderScheduleCount\n\nCounts orders scheduled for a date, shipping type, and explicit target.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/schedule-count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "schedule-count" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"scheduledDate\": \"2026-08-01\",\n \"type\": \"regular\",\n \"target\": \"automatic\",\n \"targetId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order shipment", "description": "Operation ID: UpdateOrderShipment", "request": { "method": "POST", "description": "Operation ID: UpdateOrderShipment\n\nUpdate order shipment. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/shipment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "shipment" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"7204558912004325301\",\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\",\n \"from\": \"example\",\n \"to\": \"example\",\n \"serviceType\": \"example\",\n \"serviceCost\": 1,\n \"state\": \"inTransit\",\n \"items\": [\n {\n \"orderItemId\": \"7204558912004325301\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"weight\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List order sources", "description": "Operation ID: ListOrderSources", "request": { "method": "GET", "description": "Operation ID: ListOrderSources\n\nList order sources. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "sources" ], "query": [], "variable": [] } } }, { "name": "Create order spreadsheet", "description": "Operation ID: CreateOrderSpreadsheet", "request": { "method": "POST", "description": "Operation ID: CreateOrderSpreadsheet\n\nCreate order spreadsheet. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/spreadsheet", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "spreadsheet" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"maxRows\": 1,\n \"ids\": [\n \"example\"\n ],\n \"filters\": {\n \"search\": \"polo\",\n \"statuses\": [\n \"new\"\n ],\n \"states\": [\n \"open\"\n ],\n \"fulfillmentStatuses\": [\n \"unfulfilled\"\n ],\n \"returnStatuses\": [\n \"none\"\n ],\n \"itemStatuses\": [\n \"new\"\n ],\n \"paymentCodes\": [\n \"example\"\n ],\n \"sources\": [\n \"example\"\n ]\n },\n \"pageSize\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get order spreadsheet", "description": "Operation ID: GetOrderSpreadsheet", "request": { "method": "GET", "description": "Operation ID: GetOrderSpreadsheet\n\nGet order spreadsheet. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/spreadsheet/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "spreadsheet", ":id" ], "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": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update order status in bulk", "description": "Operation ID: postV1OrdersStatusBatch", "request": { "method": "POST", "description": "Operation ID: postV1OrdersStatusBatch\n\nQueues a status change over many orders. Returns a job; transitions that are not valid for an order are reported per order.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/orders/status/batch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "status", "batch" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"targetStatus\": \"new\",\n \"allMatching\": false,\n \"comment\": \"example\",\n \"trackingNumber\": \"example\",\n \"trackingLink\": \"example\",\n \"carrierName\": \"Example resource\",\n \"invoiceNumber\": \"example\",\n \"invoiceLink\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Payments & Finance", "item": [ { "name": "List AI credit activity", "description": "Operation ID: getV1BillingCurrentAiCreditsActivity", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentAiCreditsActivity\n\nList AI credit activity. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/ai-credits/activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "ai-credits", "activity" ], "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 the current AI credit balance", "description": "Operation ID: getV1BillingCurrentAiCreditsBalance", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentAiCreditsBalance\n\nGet the current AI credit balance. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/ai-credits/balance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "ai-credits", "balance" ], "query": [], "variable": [] } } }, { "name": "Get the current AI credit catalog", "description": "Operation ID: getV1BillingCurrentAiCreditsCatalog", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentAiCreditsCatalog\n\nGet the current AI credit catalog. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/ai-credits/catalog", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "ai-credits", "catalog" ], "query": [], "variable": [] } } }, { "name": "Create an AI credit checkout", "description": "Operation ID: postV1BillingCurrentAiCreditsCheckouts", "request": { "method": "POST", "description": "Operation ID: postV1BillingCurrentAiCreditsCheckouts\n\nCreate an AI credit checkout. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/ai-credits/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "ai-credits", "checkouts" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"packCode\": \"example_code\",\n \"customCredits\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an active billing checkout", "description": "Operation ID: getV1BillingCurrentCheckoutsSessionId", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentCheckoutsSessionId\n\nGet an active billing checkout. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/checkouts/{sessionId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "checkouts", ":sessionId" ], "query": [], "variable": [ { "key": "sessionId", "value": "7204558912004325301" } ] } } }, { "name": "Confirm an embedded billing checkout", "description": "Operation ID: postV1BillingCurrentCheckoutsSessionIdConfirm", "request": { "method": "POST", "description": "Operation ID: postV1BillingCurrentCheckoutsSessionIdConfirm\n\nConfirm an embedded billing checkout. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/checkouts/{sessionId}/confirm", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "checkouts", ":sessionId", "confirm" ], "query": [], "variable": [ { "key": "sessionId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"replace_with_the_issued_token\",\n \"paymentMethodId\": \"7204558912004325301\",\n \"installments\": 1,\n \"issuerId\": \"7204558912004325301\",\n \"identificationType\": \"example\",\n \"identificationNumber\": \"example\",\n \"payerEmail\": \"andrea@example.com\",\n \"useSavedPaymentMethod\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List billing history", "description": "Operation ID: getV1BillingCurrentHistory", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentHistory\n\nLists paid billing checkout sessions for the current organization, newest first.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "history" ], "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": "Create a billing plan purchase", "description": "Operation ID: CreatePlanPurchase", "request": { "method": "POST", "description": "Operation ID: CreatePlanPurchase\n\nCreate a billing plan purchase. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/plan-purchases", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "plan-purchases" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"plan\": \"none\",\n \"billingInterval\": \"month\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the current billing subscription", "description": "Operation ID: getV1BillingCurrentSubscription", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentSubscription\n\nGet the current billing subscription. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/subscription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "subscription" ], "query": [], "variable": [] } } }, { "name": "Cancel the current billing subscription", "description": "Operation ID: CancelBillingSubscription", "request": { "method": "POST", "description": "Operation ID: CancelBillingSubscription\n\nCancel the current billing subscription. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/subscription/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "subscription", "cancel" ], "query": [], "variable": [] } } }, { "name": "Get current billing usage", "description": "Operation ID: getV1BillingCurrentUsage", "request": { "method": "GET", "description": "Operation ID: getV1BillingCurrentUsage\n\nGet current billing usage. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/billing/current/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "current", "usage" ], "query": [], "variable": [] } } }, { "name": "List available billing plans", "description": "Operation ID: getV1BillingPlans", "request": { "method": "GET", "auth": { "type": "noauth" }, "description": "Operation ID: getV1BillingPlans\n\nList available billing plans. A successful request returns HTTP 200 with the documented response body.", "header": [], "url": { "raw": "{{baseUrl}}/v1/billing/plans", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "plans" ], "query": [], "variable": [] } } }, { "name": "Cancel payment", "description": "Operation ID: CancelPayment", "request": { "method": "POST", "description": "Operation ID: CancelPayment\n\nCancel payment. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/{paymentTransactionId}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":paymentTransactionId", "cancel" ], "query": [], "variable": [ { "key": "paymentTransactionId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"message\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Capture payment", "description": "Operation ID: CapturePayment", "request": { "method": "POST", "description": "Operation ID: CapturePayment\n\nCapture payment. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/{paymentTransactionId}/capture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":paymentTransactionId", "capture" ], "query": [], "variable": [ { "key": "paymentTransactionId", "value": "7204558912004325301" } ] } } }, { "name": "List payment methods", "description": "Operation ID: ListPaymentMethods", "request": { "method": "GET", "description": "Operation ID: ListPaymentMethods\n\nList payment methods. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "methods" ], "query": [], "variable": [] } } }, { "name": "Update payment methods", "description": "Operation ID: UpdatePaymentMethods", "request": { "method": "PUT", "description": "Operation ID: UpdatePaymentMethods\n\nReplaces the store's payment method settings with the supplied list; omitted settings are removed.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "methods" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"code\": \"example_code\",\n \"isActive\": false,\n \"sortOrder\": 1,\n \"processingMode\": \"manual\",\n \"connectionId\": \"7204558912004325301\",\n \"providerMethodCode\": \"example_code\",\n \"phoneNumber\": \"+51987654321\",\n \"accountHolder\": \"example\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund payment", "description": "Operation ID: RefundPayment", "request": { "method": "POST", "description": "Operation ID: RefundPayment\n\nRefund payment. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/refund", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "refund" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"paymentTransactionId\": \"7204558912004325301\",\n \"amount\": 1,\n \"idempotencyKey\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get payment settings", "description": "Operation ID: GetPaymentSettings", "request": { "method": "GET", "description": "Operation ID: GetPaymentSettings\n\nGet payment settings. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "settings" ], "query": [], "variable": [] } } }, { "name": "Update payment settings", "description": "Operation ID: UpdatePaymentSettings", "request": { "method": "PUT", "description": "Operation ID: UpdatePaymentSettings\n\nUpdate payment settings. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "settings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"automaticAtCheckout\",\n \"defaultConnectionId\": \"7204558912004325301\",\n \"manualPaymentsEnabled\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Start payment", "description": "Operation ID: StartPayment", "request": { "method": "POST", "description": "Operation ID: StartPayment\n\nStart payment. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/payments/start", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "start" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"targetKind\": \"order\",\n \"orderId\": \"7204558912004325301\",\n \"orderGroup\": \"example\",\n \"paymentMethodCode\": \"example_code\",\n \"amount\": 1,\n \"currency\": \"PEN\",\n \"externalRef\": \"example\",\n \"payerEmail\": \"andrea@example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create seller", "description": "Operation ID: postV1Sellers", "request": { "method": "POST", "description": "Operation ID: postV1Sellers\n\nCreates a seller for a marketplace store and queues an invitation email for its owner.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"countryCode\": \"PE\",\n \"currencyCode\": \"PEN\",\n \"description\": \"Example description.\",\n \"phone\": \"+51987654321\",\n \"emailNotification\": \"andrea@example.com\",\n \"legalName\": \"Example resource\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List sellers", "description": "Operation ID: getV1Sellers", "request": { "method": "GET", "description": "Operation ID: getV1Sellers\n\nList sellers. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers" ], "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": "status", "value": "[\"active\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "includeInternal", "value": "false", "disabled": true } ], "variable": [] } } }, { "name": "Delete a seller", "description": "Operation ID: deleteV1SellersId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1SellersId\n\nDeactivates and removes a seller from the current marketplace store.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get seller by ID", "description": "Operation ID: getV1SellersId", "request": { "method": "GET", "description": "Operation ID: getV1SellersId\n\nReturns one seller with its legal, billing, catalog, shipping, fulfillment, and profile settings.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update a seller", "description": "Operation ID: patchV1SellersId", "request": { "method": "PATCH", "description": "Operation ID: patchV1SellersId\n\nUpdates a seller's identity, policies, commission, legal, billing, catalog, shipping, fulfillment, and profile settings.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"phone\": \"+51987654321\",\n \"emailNotification\": \"andrea@example.com\",\n \"deliveryPolicy\": \"example\",\n \"privacyAndSecurityPolicy\": \"example\",\n \"commissionPercent\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List seller commissions", "description": "Operation ID: getV1SellersSellerIdCommissions", "request": { "method": "GET", "description": "Operation ID: getV1SellersSellerIdCommissions\n\nList seller commissions. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/commissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "commissions" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] } } }, { "name": "Replace seller commissions", "description": "Operation ID: putV1SellersSellerIdCommissions", "request": { "method": "PUT", "description": "Operation ID: putV1SellersSellerIdCommissions\n\nReplace seller commissions. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/commissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "commissions" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] }, "body": { "mode": "raw", "raw": "{\n \"commissions\": [\n {\n \"target\": \"category\",\n \"categoryId\": \"7204558912004325301\",\n \"brandId\": \"7204558912004325301\",\n \"includeChildrenCategories\": false,\n \"productCommissionPercent\": 1,\n \"freightCommissionPercent\": 1,\n \"fixedFee\": 1,\n \"isActive\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invite a seller member", "description": "Operation ID: postV1SellersSellerIdInvitations", "request": { "method": "POST", "description": "Operation ID: postV1SellersSellerIdInvitations\n\nInvites someone to a seller with a given role.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/invitations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "invitations" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"andrea@example.com\",\n \"roleId\": \"7204558912004325301\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List seller invitations", "description": "Operation ID: getV1SellersSellerIdInvitations", "request": { "method": "GET", "description": "Operation ID: getV1SellersSellerIdInvitations\n\nLists a seller's invitations, optionally filtered by status.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/invitations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "invitations" ], "query": [ { "key": "status", "value": "[\"pending\"]", "description": "Only items in these statuses.", "disabled": true } ], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] } } }, { "name": "Delete a seller invitation", "description": "Operation ID: deleteV1SellersSellerIdInvitationsInvitationId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1SellersSellerIdInvitationsInvitationId\n\nRevokes a pending invitation. The link stops working.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/invitations/{invitationId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "invitations", ":invitationId" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." }, { "key": "invitationId", "value": "7204558912004325301" } ] } } }, { "name": "Resend a seller invitation", "description": "Operation ID: postV1SellersSellerIdInvitationsInvitationIdResend", "request": { "method": "POST", "description": "Operation ID: postV1SellersSellerIdInvitationsInvitationIdResend\n\nSends the invitation email again and extends its expiry.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/invitations/{invitationId}/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "invitations", ":invitationId", "resend" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." }, { "key": "invitationId", "value": "7204558912004325301" } ] } } }, { "name": "List seller members", "description": "Operation ID: getV1SellersSellerIdMembers", "request": { "method": "GET", "description": "Operation ID: getV1SellersSellerIdMembers\n\nLists the people with access to a seller.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/members", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "members" ], "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": "status", "value": "[\"active\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "emails", "value": "[\"andrea@example.com\"]", "disabled": true }, { "key": "names", "value": "[\"example\"]", "disabled": true }, { "key": "roles", "value": "[\"example\"]", "disabled": true }, { "key": "isOwner", "value": "false", "disabled": true } ], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] } } }, { "name": "Remove a member's access to a seller", "description": "Operation ID: deleteV1SellersSellerIdMembersMemberId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1SellersSellerIdMembersMemberId\n\nRemoves a person's access to a seller. Their user account is not deleted.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/members/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "members", ":memberId" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." }, { "key": "memberId", "value": "7204558912004325301" } ] } } }, { "name": "List seller roles", "description": "Operation ID: getV1SellersSellerIdRoles", "request": { "method": "GET", "description": "Operation ID: getV1SellersSellerIdRoles\n\nLists the roles a seller member can hold.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "roles" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] } } }, { "name": "List seller scopes", "description": "Operation ID: getV1SellersSellerIdScopes", "request": { "method": "GET", "description": "Operation ID: getV1SellersSellerIdScopes\n\nList seller scopes. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/scopes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "scopes" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] } } }, { "name": "Replace seller scopes", "description": "Operation ID: putV1SellersSellerIdScopes", "request": { "method": "PUT", "description": "Operation ID: putV1SellersSellerIdScopes\n\nReplace seller scopes. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/sellers/{sellerId}/scopes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sellers", ":sellerId", "scopes" ], "query": [], "variable": [ { "key": "sellerId", "value": "7204558912004325301", "description": "Identifier of the seller." } ] }, "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n {\n \"type\": \"category\",\n \"categoryId\": \"7204558912004325301\",\n \"brandId\": \"7204558912004325301\",\n \"includeChildrenCategories\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Platform & Identity", "item": [ { "name": "List API keys", "description": "Operation ID: getV1ApiKeys", "request": { "method": "GET", "description": "Operation ID: getV1ApiKeys\n\nReturns the API keys visible to the current user. Plaintext key values are never returned.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys" ], "query": [], "variable": [] } } }, { "name": "Create an API key", "description": "Operation ID: postV1ApiKeys", "request": { "method": "POST", "description": "Operation ID: postV1ApiKeys\n\nCreates an API key and returns its plaintext value once. This does not create an OAuth application, and documented Admin, Storefront, and Auth operations do not accept this key.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"ERP de producción\",\n \"isTestMode\": false,\n \"scopes\": [\n \"api_admin\"\n ],\n \"allowedIps\": [\n \"203.0.113.10\"\n ],\n \"expiresAt\": null,\n \"applicationUrl\": \"https://erp.example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke an API key", "description": "Operation ID: deleteV1ApiKeysId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1ApiKeysId\n\nRevokes the selected API key so it can no longer authenticate requests.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/api-keys/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Create organization", "description": "Operation ID: postV1Organizations", "request": { "method": "POST", "description": "Operation ID: postV1Organizations\n\nCreate organization. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/organizations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organizations" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"storeName\": \"Example resource\",\n \"firstName\": \"Andrea\",\n \"lastName\": \"Ramos\",\n \"organizationId\": \"7204558912004325301\",\n \"countryCode\": \"PE\",\n \"currencyCode\": \"PEN\",\n \"languageCode\": \"es\",\n \"timeZone\": \"America/Lima\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List organizations", "description": "Operation ID: getV1Organizations", "request": { "method": "GET", "description": "Operation ID: getV1Organizations\n\nLists organizations where the current user has active access, including the accessible stores and the user's role and seller context for each store.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/organizations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organizations" ], "query": [], "variable": [] } } }, { "name": "Create store", "description": "Operation ID: postV1Stores", "request": { "method": "POST", "description": "Operation ID: postV1Stores\n\nCreates a store in the current organization and starts its background provisioning.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"domain\": \"example\",\n \"logo\": \"example\",\n \"type\": \"b2C\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List stores", "description": "Operation ID: getV1Stores", "request": { "method": "GET", "description": "Operation ID: getV1Stores\n\nLists the stores the current user can access, including each store's provisioning status.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores" ], "query": [], "variable": [] } } }, { "name": "Select store", "description": "Operation ID: postV1StoresStoreIdSelect", "request": { "method": "POST", "description": "Operation ID: postV1StoresStoreIdSelect\n\nValidates that the current user has active access to the selected store and records the member's latest login time.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/{storeId}/select", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", ":storeId", "select" ], "query": [], "variable": [ { "key": "storeId", "value": "7204558912004325301" } ] } } }, { "name": "Cancel a scheduled store deletion", "description": "Operation ID: deleteV1StoresDeletion", "request": { "method": "DELETE", "description": "Operation ID: deleteV1StoresDeletion\n\nBrings the store back to active while it is still inside the grace period.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/deletion", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "deletion" ], "query": [], "variable": [] } } }, { "name": "Schedule the store for deletion", "description": "Operation ID: postV1StoresDeletion", "request": { "method": "POST", "description": "Operation ID: postV1StoresDeletion\n\nTakes the storefront offline and schedules the store for permanent deletion after a 30 day grace period. The confirmation must match the store name.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/deletion", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "deletion" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"confirmation\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add store domain", "description": "Operation ID: postV1StoresDomains", "request": { "method": "POST", "description": "Operation ID: postV1StoresDomains\n\nAdd store domain. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "domains" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List store domains", "description": "Operation ID: getV1StoresDomains", "request": { "method": "GET", "description": "Operation ID: getV1StoresDomains\n\nList store domains. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "domains" ], "query": [], "variable": [] } } }, { "name": "Remove store domain", "description": "Operation ID: deleteV1StoresDomainsDomainId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1StoresDomainsDomainId\n\nRemove store domain. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/domains/{domainId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "domains", ":domainId" ], "query": [], "variable": [ { "key": "domainId", "value": "7204558912004325301" } ] } } }, { "name": "Check store slug", "description": "Operation ID: getV1StoresExistsSlug", "request": { "method": "GET", "description": "Operation ID: getV1StoresExistsSlug\n\nReturns whether any store already uses the slug, active or not.", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/exists/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "exists", ":slug" ], "query": [], "variable": [ { "key": "slug", "value": "example-resource", "description": "URL-friendly identifier." } ] } } }, { "name": "Get store settings", "description": "Operation ID: getV1StoresSettings", "request": { "method": "GET", "description": "Operation ID: getV1StoresSettings\n\nReturns the current store's identity, localization, visibility, theme, feature, and checkout settings.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "settings" ], "query": [], "variable": [] } } }, { "name": "Update store settings", "description": "Operation ID: putV1StoresSettings", "request": { "method": "PUT", "description": "Operation ID: putV1StoresSettings\n\nUpdates the current store's identity, localization, visibility, theme, feature, checkout, and private-access settings.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "settings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"slug\": \"example-resource\",\n \"domain\": \"example\",\n \"logo\": \"example\",\n \"icon\": \"example\",\n \"visibility\": \"public\",\n \"timeZone\": \"America/Lima\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update checkout settings", "description": "Operation ID: putV1StoresSettingsCheckout", "request": { "method": "PUT", "description": "Operation ID: putV1StoresSettingsCheckout\n\nReplaces only the current store's checkout settings.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/settings/checkout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "settings", "checkout" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"checkoutSettings\": {\n \"general\": {\n \"allowGuestCheckout\": false,\n \"identityScope\": \"store\"\n },\n \"orderBumps\": {\n \"allowOnlyOneAdditionalOffer\": false,\n \"maxVisibleOffers\": 1\n },\n \"ordersAndPayments\": {\n \"allowPurchasesFrom\": \"any\",\n \"maximumItemsPerOrder\": 1,\n \"deliveryNoteText\": \"Example note.\"\n },\n \"abandonedCarts\": {\n \"sendRecoveryEmail\": false,\n \"delayHours\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update general settings", "description": "Operation ID: putV1StoresSettingsGeneral", "request": { "method": "PUT", "description": "Operation ID: putV1StoresSettingsGeneral\n\nReplaces the current store's general identity, localization, and theme settings. A null logo removes the current logo.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/settings/general", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "settings", "general" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"logo\": \"example\",\n \"language\": \"es\",\n \"currency\": \"PEN\",\n \"timeZone\": \"America/Lima\",\n \"themeConfig\": {\n \"name\": \"Example resource\",\n \"mode\": \"example\",\n \"colors\": {\n \"key\": \"example\"\n },\n \"fonts\": {\n \"key\": \"example\"\n },\n \"assets\": {\n \"key\": \"example\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refresh settings snapshot", "description": "Operation ID: postV1StoresSettingsSnapshotRefresh", "request": { "method": "POST", "description": "Operation ID: postV1StoresSettingsSnapshotRefresh\n\nRebuilds the current store's storefront settings snapshot.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/settings/snapshot/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "settings", "snapshot", "refresh" ], "query": [], "variable": [] } } }, { "name": "Update store slug", "description": "Operation ID: patchV1StoresSlug", "request": { "method": "PATCH", "description": "Operation ID: patchV1StoresSlug\n\nChanges the store slug and moves its default platform hostname to the new slug.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/stores/slug", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stores", "slug" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"slug\": \"example-resource\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Products", "item": [ { "name": "Create a product", "description": "Operation ID: CreateProduct", "request": { "method": "POST", "description": "Operation ID: CreateProduct\n\nCreates a product and its initial catalog variants.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Polo de algodón\",\n \"sku\": \"POL-001\",\n \"description\": \"Polo de algodón pima para uso diario.\",\n \"status\": \"active\",\n \"price\": 89,\n \"compareAtPrice\": 99,\n \"minOrderQuantity\": 1,\n \"isDigital\": false,\n \"trackInventory\": true,\n \"lowStockThreshold\": 5,\n \"allowBackorders\": false,\n \"tags\": [\n \"ropa\",\n \"algodón\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List products", "description": "Operation ID: ListProducts", "request": { "method": "GET", "description": "Operation ID: ListProducts\n\nReturns a paginated product list using the supplied catalog filters.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products" ], "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": "productIds", "value": "[\"example\"]", "description": "Only these products.", "disabled": true }, { "key": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "excludeStatus", "value": "[\"draft\"]", "description": "Leave out items in these statuses.", "disabled": true }, { "key": "includeArchived", "value": "false", "description": "Include archived items.", "disabled": true }, { "key": "categoryIds", "value": "[\"example\"]", "description": "Only items in these categories.", "disabled": true }, { "key": "excludeCategoryIds", "value": "[\"example\"]", "description": "Leave out items in these categories.", "disabled": true }, { "key": "brandIds", "value": "[\"example\"]", "description": "Only items of these brands.", "disabled": true }, { "key": "excludeBrandIds", "value": "[\"example\"]", "description": "Leave out items of these brands.", "disabled": true }, { "key": "storeIds", "value": "[\"example\"]", "description": "Only items of these stores.", "disabled": true }, { "key": "sellerIds", "value": "[\"example\"]", "description": "Only items of these sellers.", "disabled": true }, { "key": "excludeSellerIds", "value": "[\"example\"]", "description": "Leave out items of these sellers.", "disabled": true }, { "key": "skuIds", "value": "[\"example\"]", "description": "Filter by variant identifiers.", "disabled": true }, { "key": "skus", "value": "[\"example\"]", "description": "Filter by SKU codes.", "disabled": true }, { "key": "types", "value": "[\"product\"]", "description": "Only these product types.", "disabled": true }, { "key": "excludeTypes", "value": "[\"product\"]", "description": "Leave out these product types.", "disabled": true }, { "key": "isFeatured", "value": "false", "description": "Only featured items.", "disabled": true }, { "key": "ean", "value": "example", "description": "Filter by EAN barcode.", "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": "minOnHand", "value": "1", "description": "Minimum stock on hand.", "disabled": true }, { "key": "maxOnHand", "value": "1", "description": "Maximum stock on hand.", "disabled": true }, { "key": "minAvailable", "value": "1", "description": "Minimum stock available to sell.", "disabled": true }, { "key": "tags", "value": "[\"example\"]", "description": "Only items with any of these tags.", "disabled": true }, { "key": "excludeTags", "value": "[\"example\"]", "description": "Leave out items with any of these tags.", "disabled": true }, { "key": "includeVariants", "value": "false", "description": "Include each product's variants in the response.", "disabled": true }, { "key": "includeTotalCount", "value": "false", "description": "Include the total number of matches. Slower on large catalogs.", "disabled": true }, { "key": "projection", "value": "summary", "description": "How much of each item to return.", "disabled": true }, { "key": "channelId", "value": "7204558912004325301", "description": "Identifier of the sales channel.", "disabled": true }, { "key": "sourceIds", "value": "[\"example\"]", "description": "Only items imported from these sources.", "disabled": true } ], "variable": [] } } }, { "name": "Delete a product", "description": "Operation ID: DeleteProduct", "request": { "method": "DELETE", "description": "Operation ID: DeleteProduct\n\nSoft-deletes a product from the current store; seller-scoped callers can delete only their own products.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Get product by ID", "description": "Operation ID: GetProduct", "request": { "method": "GET", "description": "Operation ID: GetProduct\n\nReturns one product with its brand, category, media, specifications, non-deleted variants, collections, and modifiers.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Update a product", "description": "Operation ID: UpdateProduct", "request": { "method": "PATCH", "description": "Operation ID: UpdateProduct\n\nUpdates the supplied product fields. Variant entries declare create or update; update requires variantId. The list replaces the active variant set and omitted variants are archived.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"summary\": \"example\",\n \"brandId\": \"7204558912004325301\",\n \"clearBrand\": false,\n \"categoryId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product activity", "description": "Operation ID: ListProductActivity", "request": { "method": "GET", "description": "Operation ID: ListProductActivity\n\nReturns the product audit trail, including each change, timestamp, and actor.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "activity" ], "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": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant.", "disabled": true }, { "key": "locationId", "value": "7204558912004325301", "description": "Identifier of the location.", "disabled": true }, { "key": "source", "value": "product", "description": "Source of the data.", "disabled": true } ], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Get product commission", "description": "Operation ID: GetProductCommission", "request": { "method": "GET", "description": "Operation ID: GetProductCommission\n\nReturns the commission that applies to a product, resolved from the rules configured for its seller and category.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/commission", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "commission" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Create modifier group", "description": "Operation ID: CreateModifierGroup", "request": { "method": "POST", "description": "Operation ID: CreateModifierGroup\n\nCreates a modifier group and its options for a product.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/modifier-groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "modifier-groups" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"isRequired\": false,\n \"selectionType\": \"single\",\n \"minSelections\": 1,\n \"maxSelections\": 1,\n \"order\": 1,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete modifier group", "description": "Operation ID: DeleteModifierGroup", "request": { "method": "DELETE", "description": "Operation ID: DeleteModifierGroup\n\nDeletes a modifier group from a product.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/modifier-groups/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "modifier-groups", ":id" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." }, { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update modifier group", "description": "Operation ID: UpdateModifierGroup", "request": { "method": "PUT", "description": "Operation ID: UpdateModifierGroup\n\nUpdates a product modifier group and its options.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/modifier-groups/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "modifier-groups", ":id" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." }, { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"isRequired\": false,\n \"selectionType\": \"single\",\n \"minSelections\": 1,\n \"maxSelections\": 1,\n \"order\": 1,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product prices", "description": "Operation ID: getV1CatalogProductsProductIdPriceLists", "request": { "method": "GET", "description": "Operation ID: getV1CatalogProductsProductIdPriceLists\n\nList product prices. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/price-lists", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "price-lists" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Create product review", "description": "Operation ID: postV1CatalogProductsProductIdReviews", "request": { "method": "POST", "description": "Operation ID: postV1CatalogProductsProductIdReviews\n\nCreate product review. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/reviews", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "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 \"customerId\": \"7204558912004325301\",\n \"orderId\": \"7204558912004325301\",\n \"status\": \"pending\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get product size guide", "description": "Operation ID: GetProductSizeGuide", "request": { "method": "GET", "description": "Operation ID: GetProductSizeGuide\n\nReturns the size guide that applies to a product, whether attached directly or inherited from an assignment.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/size-guide", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "size-guide" ], "query": [ { "key": "gender", "value": "unisex", "description": "Gender the item is intended for.", "disabled": true }, { "key": "measurementType", "value": "body", "description": "Measurement type.", "disabled": true } ], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Set product size guide", "description": "Operation ID: SetProductSizeGuide", "request": { "method": "PUT", "description": "Operation ID: SetProductSizeGuide\n\nSets, replaces, or clears the product's direct size-guide assignment.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/size-guide", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "size-guide" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] }, "body": { "mode": "raw", "raw": "{\n \"sizeGuideId\": \"7204558912004325301\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete products in bulk", "description": "Operation ID: BatchDeleteProducts", "request": { "method": "POST", "description": "Operation ID: BatchDeleteProducts\n\nQueues the deletion of several products. Returns immediately with a job; deletion happens in the background.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/batch/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "batch", "delete" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"productIds\": [\n \"example\"\n ],\n \"expectedCount\": 1,\n \"search\": \"polo\",\n \"statusFilter\": [\n \"draft\"\n ],\n \"categoryIds\": [\n \"example\"\n ],\n \"brandIds\": [\n \"example\"\n ],\n \"sellerIds\": [\n \"example\"\n ],\n \"types\": [\n \"product\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update prices in bulk", "description": "Operation ID: BatchUpdateProductPrices", "request": { "method": "POST", "description": "Operation ID: BatchUpdateProductPrices\n\nQueues price updates for multiple products and returns the operation to track.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/batch/prices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "batch", "prices" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"targetKind\": \"product\",\n \"target\": \"example\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"clearCompareAtPrice\": false\n }\n ],\n \"reason\": \"initial\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update status in bulk", "description": "Operation ID: BatchUpdateProductStatus", "request": { "method": "PATCH", "description": "Operation ID: BatchUpdateProductStatus\n\nUpdate status in bulk. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/batch/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "batch", "status" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"productIds\": [\n \"example\"\n ],\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update status by filters", "description": "Operation ID: BatchUpdateFilteredProductStatus", "request": { "method": "PATCH", "description": "Operation ID: BatchUpdateFilteredProductStatus\n\nUpdate status by filters. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/batch/status-by-filters", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "batch", "status-by-filters" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"draft\",\n \"search\": \"polo\",\n \"statusFilter\": [\n \"draft\"\n ],\n \"categoryIds\": [\n \"example\"\n ],\n \"brandIds\": [\n \"example\"\n ],\n \"sellerIds\": [\n \"example\"\n ],\n \"types\": [\n \"product\"\n ],\n \"isFeatured\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Count products", "description": "Operation ID: CountProducts", "request": { "method": "GET", "description": "Operation ID: CountProducts\n\nReturns how many products match a filter, without returning them. Cheaper than paging through a listing when you only need the number.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "count" ], "query": [ { "key": "productIds", "value": "[\"example\"]", "description": "Only these products.", "disabled": true }, { "key": "sourceIds", "value": "[\"example\"]", "description": "Only items imported from these sources.", "disabled": true }, { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": true }, { "key": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "excludeStatus", "value": "[\"draft\"]", "description": "Leave out items in these statuses.", "disabled": true }, { "key": "includeArchived", "value": "false", "description": "Include archived items.", "disabled": true }, { "key": "categoryIds", "value": "[\"example\"]", "description": "Only items in these categories.", "disabled": true }, { "key": "excludeCategoryIds", "value": "[\"example\"]", "description": "Leave out items in these categories.", "disabled": true }, { "key": "brandIds", "value": "[\"example\"]", "description": "Only items of these brands.", "disabled": true }, { "key": "excludeBrandIds", "value": "[\"example\"]", "description": "Leave out items of these brands.", "disabled": true }, { "key": "storeIds", "value": "[\"example\"]", "description": "Only items of these stores.", "disabled": true }, { "key": "sellerIds", "value": "[\"example\"]", "description": "Only items of these sellers.", "disabled": true }, { "key": "excludeSellerIds", "value": "[\"example\"]", "description": "Leave out items of these sellers.", "disabled": true }, { "key": "skuIds", "value": "[\"example\"]", "description": "Filter by variant identifiers.", "disabled": true }, { "key": "skus", "value": "[\"example\"]", "description": "Filter by SKU codes.", "disabled": true }, { "key": "types", "value": "[\"product\"]", "description": "Only these product types.", "disabled": true }, { "key": "excludeTypes", "value": "[\"product\"]", "description": "Leave out these product types.", "disabled": true }, { "key": "isFeatured", "value": "false", "description": "Only featured items.", "disabled": true }, { "key": "ean", "value": "example", "description": "Filter by EAN barcode.", "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": "minOnHand", "value": "1", "description": "Minimum stock on hand.", "disabled": true }, { "key": "maxOnHand", "value": "1", "description": "Maximum stock on hand.", "disabled": true }, { "key": "minAvailable", "value": "1", "description": "Minimum stock available to sell.", "disabled": true }, { "key": "tags", "value": "[\"example\"]", "description": "Only items with any of these tags.", "disabled": true }, { "key": "excludeTags", "value": "[\"example\"]", "description": "Leave out items with any of these tags.", "disabled": true }, { "key": "limit", "value": "1", "description": "Maximum number of results to return.", "disabled": true }, { "key": "exact", "value": "false", "disabled": true }, { "key": "savedViewId", "value": "7204558912004325301", "disabled": true } ], "variable": [] } } }, { "name": "Export products", "description": "Operation ID: ExportProducts", "request": { "method": "POST", "description": "Operation ID: ExportProducts\n\nQueues a product export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"status\": [\n \"draft\"\n ],\n \"excludeStatus\": [\n \"draft\"\n ],\n \"includeArchived\": false,\n \"categoryIds\": [\n \"example\"\n ],\n \"excludeCategoryIds\": [\n \"example\"\n ],\n \"brandIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload import file", "description": "Operation ID: UploadProductImportAsset", "request": { "method": "POST", "description": "Operation ID: UploadProductImportAsset\n\nUploads the CSV, TSV, or XLSX source consumed by a product import.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/import-assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "import-assets" ], "query": [ { "key": "fileName", "value": "Example resource", "description": "Name of the file.", "disabled": false }, { "key": "sourceFormat", "value": "csv", "disabled": false } ], "variable": [] }, "body": { "mode": "file", "file": { "src": "./productos.csv" } } } }, { "name": "Get import schema", "description": "Operation ID: GetProductImportSchema", "request": { "method": "GET", "description": "Operation ID: GetProductImportSchema\n\nGet import schema. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/import-schema", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "import-schema" ], "query": [], "variable": [] } } }, { "name": "Download import template", "description": "Operation ID: DownloadProductImportTemplate", "request": { "method": "GET", "description": "Operation ID: DownloadProductImportTemplate\n\nDownloads the spreadsheet template for product imports, with the expected columns already in place.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/import-template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "import-template" ], "query": [], "variable": [] } } }, { "name": "Import products", "description": "Operation ID: ImportProducts", "request": { "method": "POST", "description": "Operation ID: ImportProducts\n\nQueues a product import from an uploaded file. Returns a job you poll for progress and errors; nothing is written synchronously.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/imports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "imports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"clientRunId\": \"7204558912004325301\",\n \"assetId\": \"7204558912004325301\",\n \"checksum\": \"example\",\n \"sourceFormat\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve or reject seller products", "description": "Operation ID: ModerateProducts", "request": { "method": "POST", "description": "Operation ID: ModerateProducts\n\nApproves or rejects seller products in bulk. Rejected products stay unpublished with the reason attached.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/moderation/decide", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "moderation", "decide" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"productIds\": [\n \"example\"\n ],\n \"action\": \"approve\",\n \"reason\": \"Example note.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get moderation summary", "description": "Operation ID: GetModerationSummary", "request": { "method": "GET", "description": "Operation ID: GetModerationSummary\n\nReturns the number of seller products currently pending moderation.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/moderation/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "moderation", "summary" ], "query": [], "variable": [] } } }, { "name": "Reindex products", "description": "Operation ID: postV1CatalogProductsReindex", "request": { "method": "POST", "description": "Operation ID: postV1CatalogProductsReindex\n\nQueues a search reindex of every product in the store. Use it after a bulk change, when the catalog and the search index have drifted apart.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/reindex", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "reindex" ], "query": [], "variable": [] } } }, { "name": "Save product spreadsheet", "description": "Operation ID: SaveProductSpreadsheet", "request": { "method": "POST", "description": "Operation ID: SaveProductSpreadsheet\n\nSave product spreadsheet. A successful request returns HTTP 202 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/spreadsheet/save", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "spreadsheet", "save" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"productPatches\": [\n {\n \"productId\": \"7204558912004325301\",\n \"body\": {\n \"name\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"slug\": \"example-resource\",\n \"description\": \"Example description.\",\n \"summary\": \"example\",\n \"brandId\": \"7204558912004325301\",\n \"clearBrand\": false,\n \"categoryId\": \"7204558912004325301\"\n }\n }\n ],\n \"statusGroups\": [\n {\n \"status\": \"draft\",\n \"productIds\": [\n \"example\"\n ]\n }\n ],\n \"priceItems\": [\n {\n \"targetKind\": \"product\",\n \"target\": \"example\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"clearCompareAtPrice\": false\n }\n ],\n \"inventoryItems\": [\n {\n \"variantId\": \"7204558912004325301\",\n \"locationId\": \"7204558912004325301\",\n \"onHand\": 1,\n \"expectedVersion\": 1\n }\n ],\n \"variantCreates\": [\n {\n \"productId\": \"7204558912004325301\",\n \"body\": {\n \"name\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"packageId\": \"7204558912004325301\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"costPrice\": 1,\n \"lowStockThreshold\": 1,\n \"allowBackorders\": false\n },\n \"initialInventory\": [\n {\n \"locationId\": \"7204558912004325301\",\n \"onHand\": 1\n }\n ],\n \"active\": false\n }\n ],\n \"variantUpdates\": [\n {\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\",\n \"expectedVersion\": 1,\n \"body\": {\n \"name\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"packageId\": \"7204558912004325301\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"costPrice\": 1,\n \"lowStockThreshold\": 1,\n \"allowBackorders\": false\n }\n }\n ],\n \"variantDeletes\": [\n {\n \"productId\": \"7204558912004325301\",\n \"variantId\": \"7204558912004325301\"\n }\n ],\n \"productDeletes\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Suggest products", "description": "Operation ID: getV1CatalogProductsSuggest", "request": { "method": "GET", "description": "Operation ID: getV1CatalogProductsSuggest\n\nReturns product and variant suggestions matching a name, SKU or barcode.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/suggest", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", "suggest" ], "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": "Promotions", "item": [ { "name": "Create coupon", "description": "Operation ID: postV1Coupons", "request": { "method": "POST", "description": "Operation ID: postV1Coupons\n\nCreate coupon. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"type\": \"percentage\",\n \"target\": \"order\",\n \"amount\": 1,\n \"allocation\": \"once\",\n \"maxQuantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List coupons", "description": "Operation ID: getV1Coupons", "request": { "method": "GET", "description": "Operation ID: getV1Coupons\n\nList coupons. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons" ], "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": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "type", "value": "percentage", "description": "Only this type.", "disabled": true }, { "key": "target", "value": "order", "disabled": true } ], "variable": [] } } }, { "name": "Get coupon", "description": "Operation ID: getV1CouponsCouponId", "request": { "method": "GET", "description": "Operation ID: getV1CouponsCouponId\n\nGet coupon. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons/{couponId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":couponId" ], "query": [], "variable": [ { "key": "couponId", "value": "7204558912004325301", "description": "Identifier of the coupon." } ] } } }, { "name": "Update coupon", "description": "Operation ID: putV1CouponsCouponId", "request": { "method": "PUT", "description": "Operation ID: putV1CouponsCouponId\n\nUpdate coupon. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons/{couponId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":couponId" ], "query": [], "variable": [ { "key": "couponId", "value": "7204558912004325301", "description": "Identifier of the coupon." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"type\": \"percentage\",\n \"target\": \"order\",\n \"amount\": 1,\n \"allocation\": \"once\",\n \"maxQuantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create coupon code", "description": "Operation ID: postV1CouponsCouponIdCodes", "request": { "method": "POST", "description": "Operation ID: postV1CouponsCouponIdCodes\n\nCreate coupon code. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons/{couponId}/codes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":couponId", "codes" ], "query": [], "variable": [ { "key": "couponId", "value": "7204558912004325301", "description": "Identifier of the coupon." } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"example_code\",\n \"usageLimit\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assign customers to coupon code", "description": "Operation ID: putV1CouponsCouponIdCodesCodeIdCustomers", "request": { "method": "PUT", "description": "Operation ID: putV1CouponsCouponIdCodesCodeIdCustomers\n\nAssign customers to coupon code. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons/{couponId}/codes/{codeId}/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":couponId", "codes", ":codeId", "customers" ], "query": [], "variable": [ { "key": "couponId", "value": "7204558912004325301", "description": "Identifier of the coupon." }, { "key": "codeId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Queue coupon code batch creation", "description": "Operation ID: postV1CouponsCouponIdCodesBatch", "request": { "method": "POST", "description": "Operation ID: postV1CouponsCouponIdCodesBatch\n\nQueues creation of the supplied coupon codes for the selected coupon.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/coupons/{couponId}/codes/batch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":couponId", "codes", "batch" ], "query": [], "variable": [ { "key": "couponId", "value": "7204558912004325301", "description": "Identifier of the coupon." } ] }, "body": { "mode": "raw", "raw": "{\n \"codes\": [\n \"example\"\n ],\n \"usageLimit\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List discounts", "description": "Operation ID: getV1Discounts", "request": { "method": "GET", "description": "Operation ID: getV1Discounts\n\nList discounts. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/discounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "discounts" ], "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": "status", "value": "[\"draft\"]", "description": "Only items in these statuses.", "disabled": true }, { "key": "type", "value": "percentage", "description": "Only this type.", "disabled": true }, { "key": "target", "value": "order", "disabled": true } ], "variable": [] } } }, { "name": "Create discount", "description": "Operation ID: postV1Discounts", "request": { "method": "POST", "description": "Operation ID: postV1Discounts\n\nCreate discount. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/discounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "discounts" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"type\": \"percentage\",\n \"target\": \"order\",\n \"amount\": 1,\n \"allocation\": \"once\",\n \"maxQuantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get discount", "description": "Operation ID: getV1DiscountsDiscountId", "request": { "method": "GET", "description": "Operation ID: getV1DiscountsDiscountId\n\nGet discount. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/discounts/{discountId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "discounts", ":discountId" ], "query": [], "variable": [ { "key": "discountId", "value": "7204558912004325301" } ] } } }, { "name": "Update discount", "description": "Operation ID: putV1DiscountsDiscountId", "request": { "method": "PUT", "description": "Operation ID: putV1DiscountsDiscountId\n\nUpdate discount. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/discounts/{discountId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "discounts", ":discountId" ], "query": [], "variable": [ { "key": "discountId", "value": "7204558912004325301" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"description\": \"Example description.\",\n \"status\": \"draft\",\n \"type\": \"percentage\",\n \"target\": \"order\",\n \"amount\": 1,\n \"allocation\": \"once\",\n \"maxQuantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export promotions", "description": "Operation ID: ExportPromotions", "request": { "method": "POST", "description": "Operation ID: ExportPromotions\n\nQueues a promotion export. Returns a job; the file becomes downloadable once it completes.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/promotions/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "promotions", "exports" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"csv\",\n \"search\": \"polo\",\n \"promotionIds\": [\n 1\n ],\n \"status\": [\n \"draft\"\n ],\n \"type\": \"percentage\",\n \"target\": \"order\",\n \"isAutomatic\": false,\n \"validFrom\": \"2026-08-01T15:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import promotions", "description": "Operation ID: ImportPromotions", "request": { "method": "POST", "description": "Operation ID: ImportPromotions\n\nQueues a promotion import from a file. Returns a job you poll for progress.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/promotions/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "promotions", "import" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "assetId", "value": "7204558912004325301", "type": "text" } ] } } } ] }, { "name": "Storage", "item": [ { "name": "List assets", "description": "Operation ID: getV1StorageAssets", "request": { "method": "GET", "description": "Operation ID: getV1StorageAssets\n\nList assets. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets" ], "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": "directory", "value": "example", "disabled": true }, { "key": "mimeType", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "Upload file", "description": "Operation ID: postV1StorageAssets", "request": { "method": "POST", "description": "Operation ID: postV1StorageAssets\n\nUpload file. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "./polo-de-algodon.jpg" }, { "key": "directory", "value": "products", "type": "text" }, { "key": "altText", "value": "Polo de algodón azul", "type": "text" } ] } } }, { "name": "Delete file", "description": "Operation ID: deleteV1StorageAssetsId", "request": { "method": "DELETE", "description": "Operation ID: deleteV1StorageAssetsId\n\nDelete file. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Get file", "description": "Operation ID: getV1StorageAssetsId", "request": { "method": "GET", "description": "Operation ID: getV1StorageAssetsId\n\nReturns one asset owned by the current store or seller, including its media metadata.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update file metadata", "description": "Operation ID: patchV1StorageAssetsId", "request": { "method": "PATCH", "description": "Operation ID: patchV1StorageAssetsId\n\nUpdate file metadata. A successful request returns HTTP 204 without a response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"altText\": \"example\",\n \"directory\": \"example\",\n \"metadata\": {\n \"key\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download file", "description": "Operation ID: getV1StorageAssetsIdContent", "request": { "method": "GET", "description": "Operation ID: getV1StorageAssetsIdContent\n\nDownload file. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/{id}/content", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", ":id", "content" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Upload file as Base64", "description": "Operation ID: postV1StorageAssetsBase64", "request": { "method": "POST", "description": "Operation ID: postV1StorageAssetsBase64\n\nUpload file as Base64. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/base64", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", "base64" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"dataBase64\": \"example\",\n \"filename\": \"Example resource\",\n \"contentType\": \"example\",\n \"directory\": \"example\",\n \"altText\": \"example\",\n \"metadata\": {\n \"key\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch delete assets", "description": "Operation ID: deleteV1StorageAssetsBulk", "request": { "method": "DELETE", "description": "Operation ID: deleteV1StorageAssetsBulk\n\nDeletes multiple assets and their corresponding files in the cloud provider.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", "bulk" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"example\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import file from URL", "description": "Operation ID: postV1StorageAssetsUrl", "request": { "method": "POST", "description": "Operation ID: postV1StorageAssetsUrl\n\nImport file from URL. A successful request returns HTTP 201 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/assets/url", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "assets", "url" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/resource\",\n \"filename\": \"Example resource\",\n \"directory\": \"example\",\n \"altText\": \"example\",\n \"metadata\": {\n \"key\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List unique virtual directories", "description": "Operation ID: getV1StorageDirectories", "request": { "method": "GET", "description": "Operation ID: getV1StorageDirectories\n\nList unique virtual directories. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/directories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "directories" ], "query": [ { "key": "prefix", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "List directory summaries", "description": "Operation ID: getV1StorageDirectoriesSummary", "request": { "method": "GET", "description": "Operation ID: getV1StorageDirectoriesSummary\n\nList directory summaries. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/directories/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "directories", "summary" ], "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": "prefix", "value": "example", "disabled": true } ], "variable": [] } } }, { "name": "Search stock images with advanced filters", "description": "Operation ID: getV1StorageStockImages", "request": { "method": "GET", "description": "Operation ID: getV1StorageStockImages\n\nSearch stock images with advanced filters. A successful request returns HTTP 200 with the documented response body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/storage/stock-images", "host": [ "{{baseUrl}}" ], "path": [ "v1", "storage", "stock-images" ], "query": [ { "key": "search", "value": "polo", "description": "Free-text filter. Which fields it covers depends on the resource.", "disabled": false }, { "key": "page", "value": "1", "description": "One-based page number.", "disabled": true }, { "key": "perPage", "value": "20", "disabled": true }, { "key": "orderBy", "value": "relevant", "disabled": true }, { "key": "orientation", "value": "example", "disabled": true }, { "key": "color", "value": "example", "disabled": true }, { "key": "contentFilter", "value": "low", "disabled": true }, { "key": "collections", "value": "example", "disabled": true } ], "variable": [] } } } ] }, { "name": "Variants", "item": [ { "name": "Create a product variant", "description": "Operation ID: CreateVariant", "request": { "method": "POST", "description": "Operation ID: CreateVariant\n\nCreates a variant under the specified product and returns the complete variant representation.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/variants", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "variants" ], "query": [], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Azul / M\",\n \"sku\": \"POL-001-AZ-M\",\n \"price\": 89,\n \"compareAtPrice\": 99,\n \"lowStockThreshold\": 5,\n \"allowBackorders\": false,\n \"trackInventory\": true,\n \"weight\": 0.25,\n \"unitOfMeasure\": \"kilogram\",\n \"barcode\": \"7751234567890\",\n \"isDefault\": false,\n \"isDigital\": false,\n \"options\": {\n \"Color\": \"Azul\",\n \"Talla\": \"M\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List product variants", "description": "Operation ID: ListProductVariants", "request": { "method": "GET", "description": "Operation ID: ListProductVariants\n\nLists a product's variants with name, SKU, status, order, and image; supports search and option filters.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/products/{productId}/variants", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "products", ":productId", "variants" ], "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": "optionKey", "value": "[\"example\"]", "disabled": false }, { "key": "optionValue", "value": "[\"example\"]", "disabled": false } ], "variable": [ { "key": "productId", "value": "7204558912004325301", "description": "Identifier of the product." } ] } } }, { "name": "Delete a product variant", "description": "Operation ID: DeleteVariant", "request": { "method": "DELETE", "description": "Operation ID: DeleteVariant\n\nDeletes the specified variant from the current store and seller scope.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "variants", ":variantId" ], "query": [], "variable": [ { "key": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant." } ] } } }, { "name": "Get variant by ID", "description": "Operation ID: GetVariant", "request": { "method": "GET", "description": "Operation ID: GetVariant\n\nReturns one variant from the current store and seller scope.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "variants", ":variantId" ], "query": [], "variable": [ { "key": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant." } ] } } }, { "name": "Update a product variant", "description": "Operation ID: UpdateVariant", "request": { "method": "PATCH", "description": "Operation ID: UpdateVariant\n\nUpdates only the variant fields included in the request body.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "variants", ":variantId" ], "query": [], "variable": [ { "key": "variantId", "value": "7204558912004325301", "description": "Identifier of the variant." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example resource\",\n \"sku\": \"SKU-001\",\n \"packageId\": \"7204558912004325301\",\n \"price\": 1,\n \"compareAtPrice\": 1,\n \"costPrice\": 1,\n \"lowStockThreshold\": 1,\n \"allowBackorders\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a variant spreadsheet session", "description": "Operation ID: CreateVariantSpreadsheet", "request": { "method": "POST", "description": "Operation ID: CreateVariantSpreadsheet\n\nCreates a temporary bulk-edit session scoped to variants. Use the returned session ID to page through its rows.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/variants/spreadsheet", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "variants", "spreadsheet" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"variantIds\": [\n \"example\"\n ],\n \"productIds\": [\n \"example\"\n ],\n \"inventoryItems\": [\n {\n \"variantId\": \"7204558912004325301\",\n \"locationId\": \"7204558912004325301\"\n }\n ],\n \"filters\": {\n \"source\": \"products\",\n \"search\": \"polo\",\n \"channelId\": \"7204558912004325301\",\n \"productStatus\": [\n \"draft\"\n ],\n \"excludeProductStatus\": [\n \"draft\"\n ],\n \"includeArchived\": false,\n \"locationIds\": [\n \"example\"\n ],\n \"categoryIds\": [\n \"example\"\n ]\n },\n \"locationIds\": [\n \"example\"\n ],\n \"pageSize\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a variant spreadsheet page", "description": "Operation ID: GetVariantSpreadsheet", "request": { "method": "GET", "description": "Operation ID: GetVariantSpreadsheet\n\nReturns one page of an open variant bulk edit session.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/catalog/variants/spreadsheet/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "catalog", "variants", "spreadsheet", ":id" ], "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": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook deliveries", "description": "Operation ID: ListWebhookDeliveries", "request": { "method": "GET", "description": "Operation ID: ListWebhookDeliveries\n\nLists webhook delivery attempts with cursor pagination and filters for endpoint, status, event type, date range, and seller.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "deliveries" ], "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": "endpointId", "value": "7204558912004325301", "disabled": true }, { "key": "status", "value": "success", "description": "Only items in these statuses.", "disabled": true }, { "key": "eventType", "value": "example", "disabled": true }, { "key": "fromDate", "value": "2026-08-01T15:30:00Z", "description": "Start of the date range, inclusive.", "disabled": true }, { "key": "toDate", "value": "2026-08-01T15:30:00Z", "description": "End of the date range, inclusive.", "disabled": true } ], "variable": [] } } }, { "name": "Get webhook delivery", "description": "Operation ID: GetWebhookDelivery", "request": { "method": "GET", "description": "Operation ID: GetWebhookDelivery\n\nReturns a delivery's endpoint URL, event type, status, HTTP status, attempt number, error, timestamp, and event metadata.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/deliveries/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "deliveries", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Retry webhook delivery", "description": "Operation ID: RetryWebhookDelivery", "request": { "method": "POST", "description": "Operation ID: RetryWebhookDelivery\n\nRe-enqueue a failed webhook delivery with its original payload", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/deliveries/{id}/retry", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "deliveries", ":id", "retry" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Create webhook endpoint", "description": "Operation ID: CreateWebhookEndpoint", "request": { "method": "POST", "description": "Operation ID: CreateWebhookEndpoint\n\nTests the destination URL, then creates an active webhook endpoint for the selected event types.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Pedidos al ERP\",\n \"url\": \"https://erp.example.com/webhooks/ecomiq\",\n \"eventTypes\": [\n \"order.confirmed\",\n \"catalog.product.updated\"\n ],\n \"secret\": \"whsec_replace_with_a_random_secret\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List webhook endpoints", "description": "Operation ID: ListWebhookEndpoints", "request": { "method": "GET", "description": "Operation ID: ListWebhookEndpoints\n\nLists webhook endpoints for the current store with their subscribed event types, status, delivery counters, and last delivery time.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints" ], "query": [], "variable": [] } } }, { "name": "Delete webhook endpoint", "description": "Operation ID: DeleteWebhookEndpoint", "request": { "method": "DELETE", "description": "Operation ID: DeleteWebhookEndpoint\n\nRemoves the endpoint configuration so it no longer receives future events.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Update webhook endpoint", "description": "Operation ID: UpdateWebhookEndpoint", "request": { "method": "PUT", "description": "Operation ID: UpdateWebhookEndpoint\n\nReplaces a webhook endpoint's name, URL, event subscriptions, signing secret, authentication, and custom headers.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints", ":id" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/resource\",\n \"eventTypes\": [\n \"example\"\n ],\n \"name\": \"Example resource\",\n \"secret\": \"replace_with_a_random_secret\",\n \"auth\": {\n \"type\": \"basic\",\n \"config\": {\n \"key\": \"example\"\n }\n },\n \"headers\": {\n \"key\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disable webhook endpoint", "description": "Operation ID: DisableWebhookEndpoint", "request": { "method": "POST", "description": "Operation ID: DisableWebhookEndpoint\n\nSets the endpoint status to disabled; its configuration is retained and it is excluded from future dispatches.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints/{id}/disable", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints", ":id", "disable" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Enable webhook endpoint", "description": "Operation ID: EnableWebhookEndpoint", "request": { "method": "POST", "description": "Operation ID: EnableWebhookEndpoint\n\nSets the endpoint status to active so matching future events can be dispatched to it.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints/{id}/enable", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints", ":id", "enable" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "Pause webhook endpoint", "description": "Operation ID: PauseWebhookEndpoint", "request": { "method": "POST", "description": "Operation ID: PauseWebhookEndpoint\n\nSets the endpoint status to paused; its configuration is retained and it is excluded from future dispatches.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/endpoints/{id}/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "endpoints", ":id", "pause" ], "query": [], "variable": [ { "key": "id", "value": "7204558912004325301", "description": "Unique identifier of the resource." } ] } } }, { "name": "List webhook events", "description": "Operation ID: ListWebhookEvents", "request": { "method": "GET", "description": "Operation ID: ListWebhookEvents\n\nGet all supported webhook events and their payload details", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "events" ], "query": [], "variable": [] } } }, { "name": "Get webhook event", "description": "Operation ID: GetWebhookEvent", "request": { "method": "GET", "description": "Operation ID: GetWebhookEvent\n\nReturns one supported webhook event with its category, description, subscription support, payload type, and fields.", "header": [ { "key": "x-Store-Id", "value": "", "description": "Store the request acts on. Not needed when the token is bound to a store.", "disabled": true }, { "key": "Authorization", "value": "Bearer ", "description": "OAuth 2.0 bearer token.", "disabled": false } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/events/{eventType}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "events", ":eventType" ], "query": [], "variable": [ { "key": "eventType", "value": "example" } ] } } } ] } ] }