{"items":[{"type":"link","label":"Merchant API v2","link":"/merchant-api-v2/mapi_v2_oas31","routeSlug":"/merchant-api-v2/mapi_v2_oas31","content":{"contentType":"overview","meta":{"name":"Merchant API v2"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"mapi_v2_oas31.json","url":"/_bundle/Merchant API v2/mapi_v2_oas31.json?download"},{"kind":"download","label":"mapi_v2_oas31.yaml","url":"/_bundle/Merchant API v2/mapi_v2_oas31.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://developers.hive.app","url":"https://developers.hive.app"},{"kind":"email","title":"Hive Support","email":"support@hive.app","label":"support@hive.app","withCopyButton":true,"copyContent":"support@hive.app"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"description":"Production API","url":"https://app.hive.app/merchant_api/v2"},{"description":"Staging API","url":"https://staging.app.hive.app/merchant_api/v2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Merchant API v2 (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant API v2 provides programmatic access to merchant data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"across all their sales channels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This version shifts from sales channel-scoped access to merchant-scoped access,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowing access to data across all sales channels owned by a single merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access tokens remain the same as in v1, but now they provide access to all sales channels."},"children":[]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31"}],"sectionId":"/merchant-api-v2/mapi_v2_oas31"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints are rate limited to 100 requests per minute per merchant. The following headers are included in every response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Rate-Limit-Used"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The number of requests used in the current minute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Rate-Limit-Max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The maximum number of requests allowed per minute (100)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the limit is exceeded, a 429 Too Many Requests response is returned."},"children":[]}]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/versioning-and-deprecation-policy"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning and Deprecation Policy"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v1 of the Merchant API will remain available as long as clients use it, but new features and improvements will only be added to v2. We recommend all new integrations use v2."},"children":[]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/versioning-and-deprecation-policy"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All list endpoints use cursor-based pagination. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination.next_page_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response indicates the next page. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there are no more results. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to control page size. See each endpoint's response schema for details."},"children":[]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive sends webhook notifications to inform you about important events in your merchant account. Configure webhook endpoints in your merchant dashboard. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section below for available webhook events and their payloads."},"children":[]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/webhook-security"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Security"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive signs all webhook requests with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-hive-signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to prevent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"malicious actors from sending invalid requests. This header contains a hex-encoded HMAC-SHA256"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"digest of the request body, using your API token as the key. Requests without this header or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with invalid signatures should be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ruby signature validation example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"def request_valid?(req)\n  return false if !req.post?\n  request_sig = req.get_header(\"x-hive-signature\")\n  expected_sig = OpenSSL::HMAC.hexdigest(\"sha256\", ENV[\"API_TOKEN\"], req.body)\n  Rack::Utils.secure_compare(request_sig, expected_sig)\nend\n","language":"ruby"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"def request_valid?(req)\n  return false if !req.post?\n  request_sig = req.get_header(\"x-hive-signature\")\n  expected_sig = OpenSSL::HMAC.hexdigest(\"sha256\", ENV[\"API_TOKEN\"], req.body)\n  Rack::Utils.secure_compare(request_sig, expected_sig)\nend\n"},"children":[]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/webhook-security"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/webhook-reliability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Reliability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URLs should be idempotent as Hive cannot guarantee the order of calls"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or retry attempts for the same event. What this means in practice, is that you should check the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp of the object in the payload. Ignore payloads with a timestamp older than the last"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update you saved. Only process the webhook if the updated timestamp is newer than the one you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have on file."},"children":[]}]}]}]}],"sectionId":"/merchant-api-v2/mapi_v2_oas31/section/webhook-reliability"}]}]}},{"type":"link","label":"Rate Limiting","link":"/merchant-api-v2/mapi_v2_oas31/section/rate-limiting","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/rate-limiting","content":null},{"type":"link","label":"Versioning and Deprecation Policy","link":"/merchant-api-v2/mapi_v2_oas31/section/versioning-and-deprecation-policy","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/versioning-and-deprecation-policy","content":null},{"type":"link","label":"Pagination","link":"/merchant-api-v2/mapi_v2_oas31/section/pagination","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/pagination","content":null},{"type":"link","label":"Webhooks","link":"/merchant-api-v2/mapi_v2_oas31/section/webhooks","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/webhooks","content":null},{"type":"link","label":"Webhook Security","link":"/merchant-api-v2/mapi_v2_oas31/section/webhook-security","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/webhook-security","content":null},{"type":"link","label":"Webhook Reliability","link":"/merchant-api-v2/mapi_v2_oas31/section/webhook-reliability","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/webhook-reliability","content":null},{"type":"group","label":"Inventory","link":"/merchant-api-v2/mapi_v2_oas31/inventory","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory","items":[{"label":"List inventory transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventory/listinventorytransactions","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory/listinventorytransactions","metadata":{"seo":{"title":"List inventory transactions","description":"Returns inventory transactions across all sales channels belonging to the authenticated merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInventoryTransactions","name":"List inventory transactions","isWebhook":false,"pointer":"/paths/~1inventory~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns inventory transactions across all sales channels belonging to the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"},{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"},{"name":"sku_id[in]","in":"query","schemaId":"schema_25","description":"Filter results by one or more SKU IDs"},{"name":"trigger_action[in]","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results by one or more inventory transaction trigger actions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common actions include: storage_box_add_manually, storage_box_reduce_manually, order_reserved, order_shipped, return_restocked, etc."},"children":[]}]}]}]}],"pointer":"/paths/~1inventory~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory/transactions","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"sku_id[in]","in":"query","required":false,"schemaId":"schema_25","explode":false},{"name":"trigger_action[in]","in":"query","required":false,"schemaId":"schema_26","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/inventory/transactions","href":"inventory/listinventorytransactions","openApiOperationId":"listInventoryTransactions","summary":"List inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of inventory transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory/listinventorytransactions"}],"panels":[]}]},"httpPath":"/inventory/transactions"}],"content":{"contentType":"group","meta":{"name":"Inventory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to inventory"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory/transactions","summary":"List inventory transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/listinventorytransactions","deprecated":false}]}]}]}]}},{"type":"group","label":"InventoryBatchSettings","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings","items":[{"label":"List inventory batch settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/listinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/listinventorybatchsettings","metadata":{"seo":{"title":"List inventory batch settings","description":"Returns all inventory batch settings for the merchant, including the merchant default and any SKU-specific overrides."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInventoryBatchSettings","name":"List inventory batch settings","isWebhook":false,"pointer":"/paths/~1inventory_batch_settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all inventory batch settings for the merchant, including the merchant default and any SKU-specific overrides.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"}],"pointer":"/paths/~1inventory_batch_settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory_batch_settings","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","429"],"pointer":"/inventory_batch_settings","href":"inventorybatchsettings/listinventorybatchsettings","openApiOperationId":"listInventoryBatchSettings","summary":"List inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of inventory batch settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_batch_settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/listinventorybatchsettings"}],"panels":[]}]},"httpPath":"/inventory_batch_settings"},{"label":"Get merchant default inventory batch settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/getdefaultinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/getdefaultinventorybatchsettings","metadata":{"seo":{"title":"Get merchant default inventory batch settings","description":"Returns the merchant's default inventory batch settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultInventoryBatchSettings","name":"Get merchant default inventory batch settings","isWebhook":false,"pointer":"/paths/~1inventory_batch_settings~1default/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get merchant default inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the merchant's default inventory batch settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory_batch_settings/default","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","404","429"],"pointer":"/inventory_batch_settings/default","href":"inventorybatchsettings/getdefaultinventorybatchsettings","openApiOperationId":"getDefaultInventoryBatchSettings","summary":"Get merchant default inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Merchant default inventory batch settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}},"schemaId":"components/schemas/InventoryBatchSettings"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_batch_settings~1default/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryBatchSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/getdefaultinventorybatchsettings"}],"panels":[]}]},"httpPath":"/inventory_batch_settings/default"},{"label":"Update merchant default inventory batch settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/updatedefaultinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/updatedefaultinventorybatchsettings","metadata":{"seo":{"title":"Update merchant default inventory batch settings","description":"Updates or creates the merchant's default inventory batch settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDefaultInventoryBatchSettings","name":"Update merchant default inventory batch settings","isWebhook":false,"pointer":"/paths/~1inventory_batch_settings~1default/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update merchant default inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates or creates the merchant's default inventory batch settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1inventory_batch_settings~1default/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/inventory_batch_settings/default","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["200","400","401","422","429"],"pointer":"/inventory_batch_settings/default","href":"inventorybatchsettings/updatedefaultinventorybatchsettings","openApiOperationId":"updateDefaultInventoryBatchSettings","summary":"Update merchant default inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated inventory batch settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}},"schemaId":"components/schemas/InventoryBatchSettings"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_batch_settings~1default/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryBatchSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/updatedefaultinventorybatchsettings"}],"panels":[]}]},"httpPath":"/inventory_batch_settings/default"},{"label":"Get SKU-specific inventory batch settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/getskuinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/getskuinventorybatchsettings","metadata":{"seo":{"title":"Get SKU-specific inventory batch settings","description":"Returns the SKU-specific inventory batch settings. Returns 404 if no SKU-specific settings exist."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSkuInventoryBatchSettings","name":"Get SKU-specific inventory batch settings","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SKU-specific inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the SKU-specific inventory batch settings. Returns 404 if no SKU-specific settings exist."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skus/{sku_id}/inventory_batch_settings","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","404","429"],"pointer":"/skus/{sku_id}/inventory_batch_settings","href":"inventorybatchsettings/getskuinventorybatchsettings","openApiOperationId":"getSkuInventoryBatchSettings","summary":"Get SKU-specific inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SKU-specific inventory batch settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}},"schemaId":"components/schemas/InventoryBatchSettings"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryBatchSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/getskuinventorybatchsettings"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batch_settings"},{"label":"Set SKU-specific inventory batch settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/updateskuinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/updateskuinventorybatchsettings","metadata":{"seo":{"title":"Set SKU-specific inventory batch settings","description":"Creates or updates SKU-specific inventory batch settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSkuInventoryBatchSettings","name":"Set SKU-specific inventory batch settings","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set SKU-specific inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates SKU-specific inventory batch settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/skus/{sku_id}/inventory_batch_settings","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["200","400","401","404","422","429"],"pointer":"/skus/{sku_id}/inventory_batch_settings","href":"inventorybatchsettings/updateskuinventorybatchsettings","openApiOperationId":"updateSkuInventoryBatchSettings","summary":"Set SKU-specific inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SKU-specific inventory batch settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}},"schemaId":"components/schemas/InventoryBatchSettings"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryBatchSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatchSettings"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/updateskuinventorybatchsettings"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batch_settings"},{"label":"Remove SKU-specific inventory batch settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/deleteskuinventorybatchsettings","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorybatchsettings/deleteskuinventorybatchsettings","metadata":{"seo":{"title":"Remove SKU-specific inventory batch settings","description":"Removes SKU-specific inventory batch settings, reverting to merchant default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSkuInventoryBatchSettings","name":"Remove SKU-specific inventory batch settings","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove SKU-specific inventory batch settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes SKU-specific inventory batch settings, reverting to merchant default."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/skus/{sku_id}/inventory_batch_settings","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","401","404","429"],"pointer":"/skus/{sku_id}/inventory_batch_settings","href":"inventorybatchsettings/deleteskuinventorybatchsettings","openApiOperationId":"deleteSkuInventoryBatchSettings","summary":"Remove SKU-specific inventory batch settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"SKU-specific settings removed"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorybatchsettings/deleteskuinventorybatchsettings"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batch_settings"}],"content":{"contentType":"group","meta":{"name":"InventoryBatchSettings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"InventoryBatchSettings","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to inventory batch settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory_batch_settings","summary":"List inventory batch settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventorybatchsettings/listinventorybatchsettings","deprecated":false},{"title":"/inventory_batch_settings/default","summary":"Get merchant default inventory batch settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventorybatchsettings/getdefaultinventorybatchsettings","deprecated":false},{"title":"/inventory_batch_settings/default","summary":"Update merchant default inventory batch settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/inventorybatchsettings/updatedefaultinventorybatchsettings","deprecated":false},{"title":"/skus/{sku_id}/inventory_batch_settings","summary":"Get SKU-specific inventory batch settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventorybatchsettings/getskuinventorybatchsettings","deprecated":false},{"title":"/skus/{sku_id}/inventory_batch_settings","summary":"Set SKU-specific inventory batch settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventorybatchsettings/updateskuinventorybatchsettings","deprecated":false},{"title":"/skus/{sku_id}/inventory_batch_settings","summary":"Remove SKU-specific inventory batch settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inventorybatchsettings/deleteskuinventorybatchsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory Batches","link":"/merchant-api-v2/mapi_v2_oas31/inventory-batches","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory-batches","items":[{"label":"Create an inventory batch for a SKU","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/createskuinventorybatch","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/createskuinventorybatch","metadata":{"seo":{"title":"Create an inventory batch for a SKU","description":"Creates a new inventory batch for the specified SKU. Merchants can use this to create batches before announcing restocking shipments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSkuInventoryBatch","name":"Create an inventory batch for a SKU","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an inventory batch for a SKU","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new inventory batch for the specified SKU.\nMerchants can use this to create batches before announcing restocking shipments.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchCreate"}},"schemaId":"components/schemas/InventoryBatchCreate","pointer":"/paths/~1skus~1{sku_id}~1inventory_batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skus/{sku_id}/inventory_batches","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryBatchCreate"}},"responseCodes":["201","400","401","403","404","422","429"],"pointer":"/skus/{sku_id}/inventory_batches","href":"inventory-batches/createskuinventorybatch","openApiOperationId":"createSkuInventoryBatch","summary":"Create an inventory batch for a SKU"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/InventoryBatchCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Inventory batch created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}},"schemaId":"components/schemas/InventoryBatch"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InventoryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-batches/createskuinventorybatch"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batches"},{"label":"Block an inventory batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/blockinventorybatch","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/blockinventorybatch","metadata":{"seo":{"title":"Block an inventory batch","description":"Blocks an inventory batch, preventing its stock from being used for fulfillment. This is typically used when there are quality issues with a specific batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"blockInventoryBatch","name":"Block an inventory batch","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block an inventory batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Blocks an inventory batch, preventing its stock from being used for fulfillment.\nThis is typically used when there are quality issues with a specific batch.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true},{"name":"id","in":"path","schemaId":"schema_30","description":"Inventory Batch ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchBlockRequest"}},"schemaId":"components/schemas/InventoryBatchBlockRequest","pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skus/{sku_id}/inventory_batches/{id}/block","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"},{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryBatchBlockRequest"}},"responseCodes":["201","400","401","403","404","422","429"],"pointer":"/skus/{sku_id}/inventory_batches/{id}/block","href":"inventory-batches/blockinventorybatch","openApiOperationId":"blockInventoryBatch","summary":"Block an inventory batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/InventoryBatchBlockRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchBlockRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Inventory batch blocked successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}},"schemaId":"components/schemas/InventoryBatch"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InventoryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-batches/blockinventorybatch"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batches/{id}/block"},{"label":"Unblock an inventory batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/unblockinventorybatch","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventory-batches/unblockinventorybatch","metadata":{"seo":{"title":"Unblock an inventory batch","description":"Unblocks a previously blocked inventory batch, allowing its stock to be used for fulfillment again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unblockInventoryBatch","name":"Unblock an inventory batch","isWebhook":false,"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock an inventory batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unblocks a previously blocked inventory batch, allowing its stock to be used for fulfillment again.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku_id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true},{"name":"id","in":"path","schemaId":"schema_30","description":"Inventory Batch ID","required":true}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchUnblockRequest"}},"schemaId":"components/schemas/InventoryBatchUnblockRequest","pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skus/{sku_id}/inventory_batches/{id}/unblock","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"sku_id","in":"path","required":true,"schemaId":"schema_30"},{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryBatchUnblockRequest"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/skus/{sku_id}/inventory_batches/{id}/unblock","href":"inventory-batches/unblockinventorybatch","openApiOperationId":"unblockInventoryBatch","summary":"Unblock an inventory batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/InventoryBatchUnblockRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryBatchUnblockRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inventory batch unblocked successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}},"schemaId":"components/schemas/InventoryBatch"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryBatch"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-batches/unblockinventorybatch"}],"panels":[]}]},"httpPath":"/skus/{sku_id}/inventory_batches/{id}/unblock"}],"content":{"contentType":"group","meta":{"name":"Inventory Batches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory Batches","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to inventory batches (lot/batch tracking)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/skus/{sku_id}/inventory_batches","summary":"Create an inventory batch for a SKU","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-batches/createskuinventorybatch","deprecated":false},{"title":"/skus/{sku_id}/inventory_batches/{id}/block","summary":"Block an inventory batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-batches/blockinventorybatch","deprecated":false},{"title":"/skus/{sku_id}/inventory_batches/{id}/unblock","summary":"Unblock an inventory batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-batches/unblockinventorybatch","deprecated":false}]}]}]}]}},{"type":"group","label":"InventoryTransferOrders","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders","items":[{"label":"List inventory transfer orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/listinventorytransferorders","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/listinventorytransferorders","metadata":{"seo":{"title":"List inventory transfer orders","description":"Returns all inventory transfer orders for the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInventoryTransferOrders","name":"List inventory transfer orders","isWebhook":false,"pointer":"/paths/~1inventory_transfer_orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List inventory transfer orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all inventory transfer orders for the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"},{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"}],"pointer":"/paths/~1inventory_transfer_orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory_transfer_orders","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/inventory_transfer_orders","href":"inventorytransferorders/listinventorytransferorders","openApiOperationId":"listInventoryTransferOrders","summary":"List inventory transfer orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of inventory transfer orders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_transfer_orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/listinventorytransferorders"}],"panels":[]}]},"httpPath":"/inventory_transfer_orders"},{"label":"Create a new inventory transfer order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/createinventorytransferorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/createinventorytransferorder","metadata":{"seo":{"title":"Create a new inventory transfer order","description":"Creates a new inventory transfer order for the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInventoryTransferOrder","name":"Create a new inventory transfer order","isWebhook":false,"pointer":"/paths/~1inventory_transfer_orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new inventory transfer order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new inventory transfer order for the merchant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderCreate"}},"schemaId":"components/schemas/InventoryTransferOrderCreate","pointer":"/paths/~1inventory_transfer_orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory_transfer_orders","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderCreate"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/inventory_transfer_orders","href":"inventorytransferorders/createinventorytransferorder","openApiOperationId":"createInventoryTransferOrder","summary":"Create a new inventory transfer order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/InventoryTransferOrderCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Inventory transfer order created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}},"schemaId":"components/schemas/InventoryTransferOrder"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_transfer_orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/createinventorytransferorder"}],"panels":[]}]},"httpPath":"/inventory_transfer_orders"},{"label":"Get an inventory transfer order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/getinventorytransferorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/getinventorytransferorder","metadata":{"seo":{"title":"Get an inventory transfer order","description":"Returns a specific inventory transfer order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInventoryTransferOrder","name":"Get an inventory transfer order","isWebhook":false,"pointer":"/paths/~1inventory_transfer_orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an inventory transfer order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific inventory transfer order.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Inventory Transfer Order ID","required":true}],"pointer":"/paths/~1inventory_transfer_orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory_transfer_orders/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/inventory_transfer_orders/{id}","href":"inventorytransferorders/getinventorytransferorder","openApiOperationId":"getInventoryTransferOrder","summary":"Get an inventory transfer order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An inventory transfer order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}},"schemaId":"components/schemas/InventoryTransferOrder"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_transfer_orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/getinventorytransferorder"}],"panels":[]}]},"httpPath":"/inventory_transfer_orders/{id}"},{"label":"Partially update an inventory transfer order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/patchinventorytransferorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/patchinventorytransferorder","metadata":{"seo":{"title":"Partially update an inventory transfer order","description":"Partially updates an existing inventory transfer order. Only the provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInventoryTransferOrder","name":"Partially update an inventory transfer order","isWebhook":false,"pointer":"/paths/~1inventory_transfer_orders~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an inventory transfer order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an existing inventory transfer order. Only the provided fields will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Inventory Transfer Order ID","required":true}],"pointer":"/paths/~1inventory_transfer_orders~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderPatch"}},"schemaId":"components/schemas/InventoryTransferOrderPatch","pointer":"/paths/~1inventory_transfer_orders~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/inventory_transfer_orders/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderPatch"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/inventory_transfer_orders/{id}","href":"inventorytransferorders/patchinventorytransferorder","openApiOperationId":"patchInventoryTransferOrder","summary":"Partially update an inventory transfer order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/InventoryTransferOrderPatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrderPatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inventory transfer order updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}},"schemaId":"components/schemas/InventoryTransferOrder"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_transfer_orders~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/patchinventorytransferorder"}],"panels":[]}]},"httpPath":"/inventory_transfer_orders/{id}"},{"label":"Cancel an inventory transfer order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/cancelinventorytransferorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/cancelinventorytransferorder","metadata":{"seo":{"title":"Cancel an inventory transfer order","description":"Cancels an existing inventory transfer order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelInventoryTransferOrder","name":"Cancel an inventory transfer order","isWebhook":false,"pointer":"/paths/~1inventory_transfer_orders~1{id}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an inventory transfer order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing inventory transfer order.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Inventory Transfer Order ID","required":true}],"pointer":"/paths/~1inventory_transfer_orders~1{id}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventory_transfer_orders/{id}/cancel","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429"],"pointer":"/inventory_transfer_orders/{id}/cancel","href":"inventorytransferorders/cancelinventorytransferorder","openApiOperationId":"cancelInventoryTransferOrder","summary":"Cancel an inventory transfer order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inventory transfer order cancelled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}},"schemaId":"components/schemas/InventoryTransferOrder"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransferOrder"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/cancelinventorytransferorder"}],"panels":[]}]},"httpPath":"/inventory_transfer_orders/{id}/cancel"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Inventory transfer order status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/inventorytransferorderstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/inventorytransferorders/inventorytransferorderstatusupdatedwebhook","metadata":{"seo":{"title":"Inventory transfer order status updated webhook","description":"Triggered when an inventory transfer order status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inventoryTransferOrderStatusUpdatedWebhook","name":"Inventory transfer order status updated webhook","isWebhook":true,"pointer":"/paths/inventory_transfer_order.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory transfer order status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an inventory transfer order status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/inventory_transfer_order.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"schemaId":"components/schemas/WebhookInventoryTransferOrder","pointer":"/paths/inventory_transfer_order.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"inventory_transfer_order.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"responseCodes":["200"],"pointer":"inventory_transfer_order.status_updated","href":"inventorytransferorders/inventorytransferorderstatusupdatedwebhook","openApiOperationId":"inventoryTransferOrderStatusUpdatedWebhook","summary":"Inventory transfer order status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookInventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/inventory_transfer_order.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventorytransferorders/inventorytransferorderstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"inventory_transfer_order.status_updated"}],"content":{"contentType":"group","meta":{"name":"InventoryTransferOrders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"InventoryTransferOrders","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to inventory transfer orders"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory_transfer_orders","summary":"List inventory transfer orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventorytransferorders/listinventorytransferorders","deprecated":false},{"title":"/inventory_transfer_orders","summary":"Create a new inventory transfer order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventorytransferorders/createinventorytransferorder","deprecated":false},{"title":"/inventory_transfer_orders/{id}","summary":"Get an inventory transfer order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventorytransferorders/getinventorytransferorder","deprecated":false},{"title":"/inventory_transfer_orders/{id}","summary":"Partially update an inventory transfer order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/inventorytransferorders/patchinventorytransferorder","deprecated":false},{"title":"/inventory_transfer_orders/{id}/cancel","summary":"Cancel an inventory transfer order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventorytransferorders/cancelinventorytransferorder","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"inventory_transfer_order.status_updated","summary":"Inventory transfer order status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventorytransferorders/inventorytransferorderstatusupdatedwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/merchant-api-v2/mapi_v2_oas31/orders","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/listorders","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/listorders","metadata":{"seo":{"title":"List orders","description":"Returns all orders across all sales channels belonging to the authenticated merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all orders across all sales channels belonging to the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id[in]","in":"query","schemaId":"schema_25","description":"Filter results by one or more IDs"},{"name":"merchant_order_id[in]","in":"query","schemaId":"schema_26","description":"Filter results by one or more merchant order IDs"},{"name":"sales_channel_id[in]","in":"query","schemaId":"schema_25","description":"Filter results by one or more sales channel ID"},{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"},{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"id[in]","in":"query","required":false,"schemaId":"schema_25","explode":false},{"name":"merchant_order_id[in]","in":"query","required":false,"schemaId":"schema_26","explode":false},{"name":"sales_channel_id[in]","in":"query","required":false,"schemaId":"schema_25","explode":false},{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/orders","href":"orders/listorders","openApiOperationId":"listOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of orders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33","headers":{"X-Rate-Limit-Used":{"description":"The number of requests used in the current minute.","schema":{"type":"integer"},"examples":{"default":{"value":10}}},"X-Rate-Limit-Max":{"description":"The maximum number of requests allowed per minute (100).","schema":{"type":"integer"},"examples":{"default":{"value":100}}}},"headerSchemaId":"schema_34"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listorders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Create a new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/createorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/createorder","metadata":{"seo":{"title":"Create a new order","description":"Creates a new order for a specific sales channel within the merchant's organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Create a new order","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new order for a specific sales channel within the merchant's organization.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreate"}},"schemaId":"components/schemas/OrderCreate","pointer":"/paths/~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderCreate"}},"responseCodes":["201","400","401","403","409","422","429"],"pointer":"/orders","href":"orders/createorder","openApiOperationId":"createOrder","summary":"Create a new order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/OrderCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}},"schemaId":"components/schemas/OrderBase"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/403/content/application~1json/examples/default"]},{"code":"409","description":"Conflict - the request conflicts with the current state of the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/403/content/application~1json/examples/default"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/createorder"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Get an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/getorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/getorder","metadata":{"seo":{"title":"Get an order","description":"Returns a specific order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrder","name":"Get an order","isWebhook":false,"pointer":"/paths/~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific order.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Order ID","required":true}],"pointer":"/paths/~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/orders/{id}","href":"orders/getorder","openApiOperationId":"getOrder","summary":"Get an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorder"}],"panels":[]}]},"httpPath":"/orders/{id}"},{"label":"Partially update an order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/patchorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/patchorder","metadata":{"seo":{"title":"Partially update an order","description":"Partially updates an existing order. Only the provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrder","name":"Partially update an order","isWebhook":false,"pointer":"/paths/~1orders~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an existing order. Only the provided fields will be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The unique identifiers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated and will be ignored if provided in the request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Order ID","required":true}],"pointer":"/paths/~1orders~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPatch","exampleIds":["paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"]}},"schemaId":"components/schemas/OrderPatch","exampleIds":["paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"],"pointer":"/paths/~1orders~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/orders/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderPatch","exampleIds":["paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"]}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/orders/{id}","href":"orders/patchorder","openApiOperationId":"patchOrder","summary":"Partially update an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/OrderPatch","exampleIds":["paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPatch","exampleIds":["paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase","exampleIds":["paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated"]}},"schemaId":"components/schemas/OrderBase","exampleIds":["paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated"]},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderBase","exampleIds":["paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase","exampleIds":["paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/patchorder"}],"panels":[]}]},"httpPath":"/orders/{id}"},{"label":"Cancel an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/cancelorder","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/cancelorder","metadata":{"seo":{"title":"Cancel an order","description":"Cancels an existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelOrder","name":"Cancel an order","isWebhook":false,"pointer":"/paths/~1orders~1{id}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing order.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Order ID","required":true}],"pointer":"/paths/~1orders~1{id}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{id}/cancel","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429"],"pointer":"/orders/{id}/cancel","href":"orders/cancelorder","openApiOperationId":"cancelOrder","summary":"Cancel an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order cancelled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}},"schemaId":"components/schemas/OrderBase"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/cancelorder"}],"panels":[]}]},"httpPath":"/orders/{id}/cancel"},{"label":"Get an order by merchant order ID and sales channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/getorderbymerchantid","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/getorderbymerchantid","metadata":{"seo":{"title":"Get an order by merchant order ID and sales channel","description":"Returns a specific order using the merchant's order ID and sales channel ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderByMerchantId","name":"Get an order by merchant order ID and sales channel","isWebhook":false,"pointer":"/paths/~1orders~1by_merchant_order_id/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an order by merchant order ID and sales channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific order using the merchant's order ID and sales channel ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sales_channel_id","in":"query","schemaId":"schema_30","required":true},{"name":"merchant_order_id","in":"query","schemaId":"schema_35","required":true}],"pointer":"/paths/~1orders~1by_merchant_order_id/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/by_merchant_order_id","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sales_channel_id","in":"query","required":true,"schemaId":"schema_30"},{"name":"merchant_order_id","in":"query","required":true,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/orders/by_merchant_order_id","href":"orders/getorderbymerchantid","openApiOperationId":"getOrderByMerchantId","summary":"Get an order by merchant order ID and sales channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders~1by_merchant_order_id/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderbymerchantid"}],"panels":[]}]},"httpPath":"/orders/by_merchant_order_id"},{"label":"Partially update an order by merchant order ID and sales channel","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/patchorderbymerchantid","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/patchorderbymerchantid","metadata":{"seo":{"title":"Partially update an order by merchant order ID and sales channel","description":"Partially updates an order using the merchant's order ID and sales channel ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrderByMerchantId","name":"Partially update an order by merchant order ID and sales channel","isWebhook":false,"pointer":"/paths/~1orders~1by_merchant_order_id/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order by merchant order ID and sales channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an order using the merchant's order ID and sales channel ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The unique identifiers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated and will be ignored if provided in the request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sales_channel_id","in":"query","schemaId":"schema_30","required":true},{"name":"merchant_order_id","in":"query","schemaId":"schema_35","required":true}],"pointer":"/paths/~1orders~1by_merchant_order_id/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPatch"}},"schemaId":"components/schemas/OrderPatch","pointer":"/paths/~1orders~1by_merchant_order_id/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/orders/by_merchant_order_id","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sales_channel_id","in":"query","required":true,"schemaId":"schema_30"},{"name":"merchant_order_id","in":"query","required":true,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderPatch"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/orders/by_merchant_order_id","href":"orders/patchorderbymerchantid","openApiOperationId":"patchOrderByMerchantId","summary":"Partially update an order by merchant order ID and sales channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/OrderPatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}},"schemaId":"components/schemas/OrderBase"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1orders~1by_merchant_order_id/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBase"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/patchorderbymerchantid"}],"panels":[]}]},"httpPath":"/orders/by_merchant_order_id"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Order status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/orders/orderstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/orders/orderstatusupdatedwebhook","metadata":{"seo":{"title":"Order status updated webhook","description":"Triggered when an order status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderStatusUpdatedWebhook","name":"Order status updated webhook","isWebhook":true,"pointer":"/paths/order.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an order status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/order.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"schemaId":"components/schemas/WebhookOrder","pointer":"/paths/order.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"responseCodes":["200","422"],"pointer":"order.status_updated","href":"orders/orderstatusupdatedwebhook","openApiOperationId":"orderStatusUpdatedWebhook","summary":"Order status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"},{"code":"422","description":"Webhook payload validation failed"}],"pointer":"/paths/order.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/orderstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"order.status_updated"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to orders"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listorders","deprecated":false},{"title":"/orders","summary":"Create a new order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/createorder","deprecated":false},{"title":"/orders/{id}","summary":"Get an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorder","deprecated":false},{"title":"/orders/{id}","summary":"Partially update an order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/patchorder","deprecated":false},{"title":"/orders/{id}/cancel","summary":"Cancel an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/cancelorder","deprecated":false},{"title":"/orders/by_merchant_order_id","summary":"Get an order by merchant order ID and sales channel","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderbymerchantid","deprecated":false},{"title":"/orders/by_merchant_order_id","summary":"Partially update an order by merchant order ID and sales channel","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/patchorderbymerchantid","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"order.status_updated","summary":"Order status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/orderstatusupdatedwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"RestockingShipments","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments","items":[{"label":"List restocking shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/listrestockingshipments","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/listrestockingshipments","metadata":{"seo":{"title":"List restocking shipments","description":"Returns all restocking shipments for the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRestockingShipments","name":"List restocking shipments","isWebhook":false,"pointer":"/paths/~1restocking_shipments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List restocking shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all restocking shipments for the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"},{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"}],"pointer":"/paths/~1restocking_shipments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/restocking_shipments","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"limit","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/restocking_shipments","href":"restockingshipments/listrestockingshipments","openApiOperationId":"listRestockingShipments","summary":"List restocking shipments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of restocking shipments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1restocking_shipments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/listrestockingshipments"}],"panels":[]}]},"httpPath":"/restocking_shipments"},{"label":"Create a restocking shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/createrestockingshipment","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/createrestockingshipment","metadata":{"seo":{"title":"Create a restocking shipment","description":"Creates a new restocking shipment for the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRestockingShipment","name":"Create a restocking shipment","isWebhook":false,"pointer":"/paths/~1restocking_shipments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a restocking shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new restocking shipment for the merchant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestockingShipmentCreate"}},"schemaId":"components/schemas/RestockingShipmentCreate","pointer":"/paths/~1restocking_shipments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/restocking_shipments","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestockingShipmentCreate"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/restocking_shipments","href":"restockingshipments/createrestockingshipment","openApiOperationId":"createRestockingShipment","summary":"Create a restocking shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/RestockingShipmentCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestockingShipmentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Restocking shipment created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}},"schemaId":"components/schemas/RestockingShipment"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1restocking_shipments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/RestockingShipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/createrestockingshipment"}],"panels":[]}]},"httpPath":"/restocking_shipments"},{"label":"Get a restocking shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/getrestockingshipment","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/getrestockingshipment","metadata":{"seo":{"title":"Get a restocking shipment","description":"Returns a specific restocking shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRestockingShipment","name":"Get a restocking shipment","isWebhook":false,"pointer":"/paths/~1restocking_shipments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a restocking shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific restocking shipment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Restocking Shipment ID","required":true}],"pointer":"/paths/~1restocking_shipments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/restocking_shipments/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/restocking_shipments/{id}","href":"restockingshipments/getrestockingshipment","openApiOperationId":"getRestockingShipment","summary":"Get a restocking shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A restocking shipment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}},"schemaId":"components/schemas/RestockingShipment"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1restocking_shipments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestockingShipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/getrestockingshipment"}],"panels":[]}]},"httpPath":"/restocking_shipments/{id}"},{"label":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/updaterestockingshipment","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/updaterestockingshipment","metadata":{"seo":{"title":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")","description":"Updates an existing restocking shipment. Only allowed if the shipment status is \"shipped\" or \"created\". This operation replaces the entire resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRestockingShipment","name":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")","isWebhook":false,"pointer":"/paths/~1restocking_shipments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing restocking shipment. Only allowed if the shipment status is \"shipped\" or \"created\". This operation replaces the entire resource.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Restocking Shipment ID","required":true}],"pointer":"/paths/~1restocking_shipments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestockingShipmentUpdate"}},"schemaId":"components/schemas/RestockingShipmentUpdate","pointer":"/paths/~1restocking_shipments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/restocking_shipments/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestockingShipmentUpdate"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/restocking_shipments/{id}","href":"restockingshipments/updaterestockingshipment","openApiOperationId":"updateRestockingShipment","summary":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/RestockingShipmentUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestockingShipmentUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Restocking shipment updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}},"schemaId":"components/schemas/RestockingShipment"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1restocking_shipments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestockingShipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestockingShipment"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/updaterestockingshipment"}],"panels":[]}]},"httpPath":"/restocking_shipments/{id}"},{"label":"Cancel a restocking shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/cancelrestockingshipment","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/cancelrestockingshipment","metadata":{"seo":{"title":"Cancel a restocking shipment","description":"Cancels an existing restocking shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelRestockingShipment","name":"Cancel a restocking shipment","isWebhook":false,"pointer":"/paths/~1restocking_shipments~1{id}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a restocking shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing restocking shipment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Restocking Shipment ID","required":true}],"pointer":"/paths/~1restocking_shipments~1{id}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/restocking_shipments/{id}/cancel","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429"],"pointer":"/restocking_shipments/{id}/cancel","href":"restockingshipments/cancelrestockingshipment","openApiOperationId":"cancelRestockingShipment","summary":"Cancel a restocking shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Restocking shipment cancelled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1restocking_shipments~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/cancelrestockingshipment"}],"panels":[]}]},"httpPath":"/restocking_shipments/{id}/cancel"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Restocking shipment status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/restockingshipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/restockingshipments/restockingshipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Restocking shipment status updated webhook","description":"Triggered when a restocking shipment status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restockingShipmentStatusUpdatedWebhook","name":"Restocking shipment status updated webhook","isWebhook":true,"pointer":"/paths/restocking_shipment.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restocking shipment status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a restocking shipment status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/restocking_shipment.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"schemaId":"components/schemas/WebhookRestockingShipment","pointer":"/paths/restocking_shipment.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"restocking_shipment.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"responseCodes":["200"],"pointer":"restocking_shipment.status_updated","href":"restockingshipments/restockingshipmentstatusupdatedwebhook","openApiOperationId":"restockingShipmentStatusUpdatedWebhook","summary":"Restocking shipment status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookRestockingShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/restocking_shipment.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restockingshipments/restockingshipmentstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"restocking_shipment.status_updated"}],"content":{"contentType":"group","meta":{"name":"RestockingShipments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RestockingShipments","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to restocking shipments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/restocking_shipments","summary":"List restocking shipments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/restockingshipments/listrestockingshipments","deprecated":false},{"title":"/restocking_shipments","summary":"Create a restocking shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/restockingshipments/createrestockingshipment","deprecated":false},{"title":"/restocking_shipments/{id}","summary":"Get a restocking shipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/restockingshipments/getrestockingshipment","deprecated":false},{"title":"/restocking_shipments/{id}","summary":"Update a restocking shipment (replace only, allowed if status is \"shipped\" or \"created\")","prefix":{"name":"put","color":"put"},"badges":[],"link":"/restockingshipments/updaterestockingshipment","deprecated":false},{"title":"/restocking_shipments/{id}/cancel","summary":"Cancel a restocking shipment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/restockingshipments/cancelrestockingshipment","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"restocking_shipment.status_updated","summary":"Restocking shipment status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/restockingshipments/restockingshipmentstatusupdatedwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Returns","link":"/merchant-api-v2/mapi_v2_oas31/returns","routeSlug":"/merchant-api-v2/mapi_v2_oas31/returns","items":[{"label":"List returns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/returns/listreturns","routeSlug":"/merchant-api-v2/mapi_v2_oas31/returns/listreturns","metadata":{"seo":{"title":"List returns","description":"Returns all returns across all sales channels belonging to the authenticated merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReturns","name":"List returns","isWebhook":false,"pointer":"/paths/~1returns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List returns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all returns across all sales channels belonging to the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sales_channel_id[in]","in":"query","schemaId":"schema_25","description":"Filter results by one or more sales channel ID"},{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"},{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"}],"pointer":"/paths/~1returns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/returns","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sales_channel_id[in]","in":"query","required":false,"schemaId":"schema_25","explode":false},{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"limit","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/returns","href":"returns/listreturns","openApiOperationId":"listReturns","summary":"List returns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of returns","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1returns/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/listreturns"}],"panels":[]}]},"httpPath":"/returns"},{"label":"Get a return","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/returns/getreturn","routeSlug":"/merchant-api-v2/mapi_v2_oas31/returns/getreturn","metadata":{"seo":{"title":"Get a return","description":"Returns a specific return."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReturn","name":"Get a return","isWebhook":false,"pointer":"/paths/~1returns~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a return","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific return.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Return ID","required":true}],"pointer":"/paths/~1returns~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/returns/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/returns/{id}","href":"returns/getreturn","openApiOperationId":"getReturn","summary":"Get a return"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A return","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1returns~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/getreturn"}],"panels":[]}]},"httpPath":"/returns/{id}"},{"label":"Get return rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/returns/getreturnrules","routeSlug":"/merchant-api-v2/mapi_v2_oas31/returns/getreturnrules","metadata":{"seo":{"title":"Get return rules","description":"Returns the merchant's return rules: the configured send-back address, the default follow-up action per return condition (A/B/C), and any SKU-specific overrides."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReturnRules","name":"Get return rules","isWebhook":false,"pointer":"/paths/~1return_rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get return rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the merchant's return rules: the configured send-back address,\nthe default follow-up action per return condition (A/B/C), and any\nSKU-specific overrides.\n\nUse this endpoint to look up the send-back address before creating a\nsend-back order.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/return_rules","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/return_rules","href":"returns/getreturnrules","openApiOperationId":"getReturnRules","summary":"Get return rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant's return rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReturnRules"}},"schemaId":"components/schemas/ReturnRules"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1return_rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReturnRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReturnRules"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1return_rules/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/getreturnrules"}],"panels":[]}]},"httpPath":"/return_rules"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Return status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/returns/returnstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/returns/returnstatusupdatedwebhook","metadata":{"seo":{"title":"Return status updated webhook","description":"Triggered when a return status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnStatusUpdatedWebhook","name":"Return status updated webhook","isWebhook":true,"pointer":"/paths/return.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a return status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/return.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"schemaId":"components/schemas/WebhookReturn","pointer":"/paths/return.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"return.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"responseCodes":["200"],"pointer":"return.status_updated","href":"returns/returnstatusupdatedwebhook","openApiOperationId":"returnStatusUpdatedWebhook","summary":"Return status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookReturn","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/return.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/returnstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"return.status_updated"}],"content":{"contentType":"group","meta":{"name":"Returns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to returns"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/returns","summary":"List returns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/listreturns","deprecated":false},{"title":"/returns/{id}","summary":"Get a return","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/getreturn","deprecated":false},{"title":"/return_rules","summary":"Get return rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/getreturnrules","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"return.status_updated","summary":"Return status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/returnstatusupdatedwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"SKUs","link":"/merchant-api-v2/mapi_v2_oas31/skus","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus","items":[{"label":"List SKUs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/listskus","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/listskus","metadata":{"seo":{"title":"List SKUs","description":"Returns all SKUs belonging to the authenticated merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSkus","name":"List SKUs","isWebhook":false,"pointer":"/paths/~1skus/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SKUs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all SKUs belonging to the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"},{"name":"created_at[gt]","in":"query","schemaId":"schema_24","description":"Filter results created after this date (ISO 8601 format)"},{"name":"created_at[lt]","in":"query","schemaId":"schema_24","description":"Filter results created before this date (ISO 8601 format)"},{"name":"created_at[gte]","in":"query","schemaId":"schema_24","description":"Filter results created on or after this date (ISO 8601 format)"},{"name":"created_at[lte]","in":"query","schemaId":"schema_24","description":"Filter results created on or before this date (ISO 8601 format)"},{"name":"sku_code[in]","in":"query","schemaId":"schema_39","description":"Filter results by one or more merchant SKU codes"},{"name":"include_archived_batches","in":"query","schemaId":"schema_40","description":"When true, includes archived inventory batches in addition to active ones. Defaults to false (only active batches are returned)."}],"pointer":"/paths/~1skus/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skus","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"created_at[gt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lt]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[gte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"created_at[lte]","in":"query","required":false,"schemaId":"schema_24"},{"name":"sku_code[in]","in":"query","required":false,"schemaId":"schema_39","explode":false},{"name":"include_archived_batches","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/skus","href":"skus/listskus","openApiOperationId":"listSkus","summary":"List SKUs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of SKUs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/listskus"}],"panels":[]}]},"httpPath":"/skus"},{"label":"Create a new SKU","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/createsku","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/createsku","metadata":{"seo":{"title":"Create a new SKU","description":"Creates a new SKU for the merchant. SKUs must have a unique SKU code.New SKUs are marked as \"verified\" and fulfilled_by \"hive\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSku","name":"Create a new SKU","isWebhook":false,"pointer":"/paths/~1skus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new SKU","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new SKU for the merchant. SKUs must have a unique SKU code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New SKUs are marked as \"verified\" and fulfilled_by \"hive\"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuCreate"}},"schemaId":"components/schemas/SkuCreate","pointer":"/paths/~1skus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skus","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SkuCreate"}},"responseCodes":["201","400","401","403","409","422","429"],"pointer":"/skus","href":"skus/createsku","openApiOperationId":"createSku","summary":"Create a new SKU"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/SkuCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"SKU created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}},"schemaId":"components/schemas/Sku"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/403/content/application~1json/examples/default"]},{"code":"409","description":"Conflict - the request conflicts with the current state of the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Sku","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus/post/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/403/content/application~1json/examples/default"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus/post/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus/post/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/createsku"}],"panels":[]}]},"httpPath":"/skus"},{"label":"Delete a SKU","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/deletesku","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/deletesku","metadata":{"seo":{"title":"Delete a SKU","description":"Deletes an existing SKU."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSku","name":"Delete a SKU","isWebhook":false,"pointer":"/paths/~1skus~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a SKU","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing SKU.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/skus/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/skus/{id}","href":"skus/deletesku","openApiOperationId":"deleteSku","summary":"Delete a SKU"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"SKU deleted successfully"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/deletesku"}],"panels":[]}]},"httpPath":"/skus/{id}"},{"label":"Get a SKU by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/getsku","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/getsku","metadata":{"seo":{"title":"Get a SKU by ID","description":"Returns a specific SKU by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSku","name":"Get a SKU by ID","isWebhook":false,"pointer":"/paths/~1skus~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a SKU by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific SKU by its ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_archived_batches","in":"query","schemaId":"schema_40","description":"When true, includes archived inventory batches in addition to active ones. Defaults to false (only active batches are returned)."}],"pointer":"/paths/~1skus~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skus/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[{"name":"include_archived_batches","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/skus/{id}","href":"skus/getsku","openApiOperationId":"getSku","summary":"Get a SKU by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A SKU","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}},"schemaId":"components/schemas/Sku"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Sku","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/getsku"}],"panels":[]}]},"httpPath":"/skus/{id}"},{"label":"Partially update a SKU","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/patchsku","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/patchsku","metadata":{"seo":{"title":"Partially update a SKU","description":"Partially updates an existing SKU. Only the provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSku","name":"Partially update a SKU","isWebhook":false,"pointer":"/paths/~1skus~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a SKU","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an existing SKU. Only the provided fields will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"SKU ID","required":true}],"pointer":"/paths/~1skus~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"schemaId":"components/schemas/SkuPatch","pointer":"/paths/~1skus~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/skus/{id}","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"responseCodes":["200","400","401","403","404","409","422","429"],"pointer":"/skus/{id}","href":"skus/patchsku","openApiOperationId":"patchSku","summary":"Partially update a SKU"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/SkuPatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SKU updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}},"schemaId":"components/schemas/Sku"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default"]},{"code":"409","description":"Conflict - the request conflicts with the current state of the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Sku","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict","paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/patchsku"}],"panels":[]}]},"httpPath":"/skus/{id}"},{"label":"Get a SKU by merchant SKU code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/getskubycode","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/getskubycode","metadata":{"seo":{"title":"Get a SKU by merchant SKU code","description":"Returns a specific SKU using the merchant's SKU code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSkuByCode","name":"Get a SKU by merchant SKU code","isWebhook":false,"pointer":"/paths/~1skus~1by_sku_code/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a SKU by merchant SKU code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific SKU using the merchant's SKU code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sku_code","in":"query","schemaId":"schema_42","required":true},{"name":"include_archived_batches","in":"query","schemaId":"schema_40","description":"When true, includes archived inventory batches in addition to active ones. Defaults to false (only active batches are returned)."}],"pointer":"/paths/~1skus~1by_sku_code/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skus/by_sku_code","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sku_code","in":"query","required":true,"schemaId":"schema_42"},{"name":"include_archived_batches","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/skus/by_sku_code","href":"skus/getskubycode","openApiOperationId":"getSkuByCode","summary":"Get a SKU by merchant SKU code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A SKU","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}},"schemaId":"components/schemas/Sku"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1by_sku_code/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Sku","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/getskubycode"}],"panels":[]}]},"httpPath":"/skus/by_sku_code"},{"label":"Partially update a SKU by merchant SKU code","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/patchskubycode","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/patchskubycode","metadata":{"seo":{"title":"Partially update a SKU by merchant SKU code","description":"Partially updates a SKU using the merchant's SKU code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSkuByCode","name":"Partially update a SKU by merchant SKU code","isWebhook":false,"pointer":"/paths/~1skus~1by_sku_code/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a SKU by merchant SKU code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a SKU using the merchant's SKU code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sku_code","in":"query","schemaId":"schema_42","required":true}],"pointer":"/paths/~1skus~1by_sku_code/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"schemaId":"components/schemas/SkuPatch","pointer":"/paths/~1skus~1by_sku_code/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/skus/by_sku_code","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sku_code","in":"query","required":true,"schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/skus/by_sku_code","href":"skus/patchskubycode","openApiOperationId":"patchSkuByCode","summary":"Partially update a SKU by merchant SKU code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/SkuPatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SkuPatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SKU updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}},"schemaId":"components/schemas/Sku"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Validation error - the request contains invalid data","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1by_sku_code/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Sku","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Sku"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/validation_errors","paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/detailed_validation"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/patchskubycode"}],"panels":[]}]},"httpPath":"/skus/by_sku_code"},{"label":"Delete a SKU by merchant SKU code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/skus/deleteskubycode","routeSlug":"/merchant-api-v2/mapi_v2_oas31/skus/deleteskubycode","metadata":{"seo":{"title":"Delete a SKU by merchant SKU code","description":"Deletes a SKU using the merchant's SKU code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSkuByCode","name":"Delete a SKU by merchant SKU code","isWebhook":false,"pointer":"/paths/~1skus~1by_sku_code/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a SKU by merchant SKU code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a SKU using the merchant's SKU code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sku_code","in":"query","schemaId":"schema_42","required":true}],"pointer":"/paths/~1skus~1by_sku_code/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/skus/by_sku_code","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"sku_code","in":"query","required":true,"schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429"],"pointer":"/skus/by_sku_code","href":"skus/deleteskubycode","openApiOperationId":"deleteSkuByCode","summary":"Delete a SKU by merchant SKU code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"SKU deleted successfully"},{"code":"400","description":"Bad request - the request couldn't be understood or contains invalid parameters","mediaType":"application/json","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/general_bad_request"]}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Resource not found - the requested resource doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1skus~1by_sku_code/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json","application/problem+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"},"application/problem+json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/openapi_validation","paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/general_bad_request"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/skus/deleteskubycode"}],"panels":[]}]},"httpPath":"/skus/by_sku_code"}],"content":{"contentType":"group","meta":{"name":"SKUs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SKUs","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to Stock Keeping Units (SKUs)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/skus","summary":"List SKUs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skus/listskus","deprecated":false},{"title":"/skus","summary":"Create a new SKU","prefix":{"name":"post","color":"post"},"badges":[],"link":"/skus/createsku","deprecated":false},{"title":"/skus/{id}","summary":"Delete a SKU","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/skus/deletesku","deprecated":false},{"title":"/skus/{id}","summary":"Get a SKU by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skus/getsku","deprecated":false},{"title":"/skus/{id}","summary":"Partially update a SKU","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/skus/patchsku","deprecated":false},{"title":"/skus/by_sku_code","summary":"Get a SKU by merchant SKU code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skus/getskubycode","deprecated":false},{"title":"/skus/by_sku_code","summary":"Partially update a SKU by merchant SKU code","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/skus/patchskubycode","deprecated":false},{"title":"/skus/by_sku_code","summary":"Delete a SKU by merchant SKU code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/skus/deleteskubycode","deprecated":false}]}]}]}]}},{"type":"group","label":"SalesChannels","link":"/merchant-api-v2/mapi_v2_oas31/saleschannels","routeSlug":"/merchant-api-v2/mapi_v2_oas31/saleschannels","items":[{"label":"List sales channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/saleschannels/listsaleschannels","routeSlug":"/merchant-api-v2/mapi_v2_oas31/saleschannels/listsaleschannels","metadata":{"seo":{"title":"List sales channels","description":"Returns all sales channels available to the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSalesChannels","name":"List sales channels","isWebhook":false,"pointer":"/paths/~1sales_channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sales channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all sales channels available to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"}],"pointer":"/paths/~1sales_channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sales_channels","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/sales_channels","href":"saleschannels/listsaleschannels","openApiOperationId":"listSalesChannels","summary":"List sales channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of sales channels","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1sales_channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1sales_channels/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/saleschannels/listsaleschannels"}],"panels":[]}]},"httpPath":"/sales_channels"}],"content":{"contentType":"group","meta":{"name":"SalesChannels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SalesChannels","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to sales channels"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sales_channels","summary":"List sales channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/saleschannels/listsaleschannels","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipments","link":"/merchant-api-v2/mapi_v2_oas31/shipments","routeSlug":"/merchant-api-v2/mapi_v2_oas31/shipments","items":[{"label":"List shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/shipments/listshipments","routeSlug":"/merchant-api-v2/mapi_v2_oas31/shipments/listshipments","metadata":{"seo":{"title":"List shipments","description":"Returns all shipments across all sales channels belonging to the authenticated merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShipments","name":"List shipments","isWebhook":false,"pointer":"/paths/~1shipments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all shipments across all sales channels belonging to the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"},{"name":"order_id[in]","in":"query","schemaId":"schema_25","description":"Filter results by one or more Hive order IDs"},{"name":"merchant_order_id[in]","in":"query","schemaId":"schema_26","description":"Filter results by one or more merchant order IDs"}],"pointer":"/paths/~1shipments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipments","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"order_id[in]","in":"query","required":false,"schemaId":"schema_25","explode":false},{"name":"merchant_order_id[in]","in":"query","required":false,"schemaId":"schema_26","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/shipments","href":"shipments/listshipments","openApiOperationId":"listShipments","summary":"List shipments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of shipments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1shipments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1shipments/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/listshipments"}],"panels":[]}]},"httpPath":"/shipments"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Shipment status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/shipments/shipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/shipments/shipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Shipment status updated webhook","description":"Triggered when a shipment status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentStatusUpdatedWebhook","name":"Shipment status updated webhook","isWebhook":true,"pointer":"/paths/shipment.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a shipment status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/shipment.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"schemaId":"components/schemas/WebhookShipment","pointer":"/paths/shipment.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"shipment.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"responseCodes":["200"],"pointer":"shipment.status_updated","href":"shipments/shipmentstatusupdatedwebhook","openApiOperationId":"shipmentStatusUpdatedWebhook","summary":"Shipment status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/shipment.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/shipmentstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"shipment.status_updated"},{"label":"Shipment delivery status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/shipments/shipmentdeliverystatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/shipments/shipmentdeliverystatusupdatedwebhook","metadata":{"seo":{"title":"Shipment delivery status updated webhook","description":"Triggered when a shipment delivery status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentDeliveryStatusUpdatedWebhook","name":"Shipment delivery status updated webhook","isWebhook":true,"pointer":"/paths/shipment.delivery_status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment delivery status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a shipment delivery status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/shipment.delivery_status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"schemaId":"components/schemas/WebhookShipment","pointer":"/paths/shipment.delivery_status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"shipment.delivery_status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"responseCodes":["200"],"pointer":"shipment.delivery_status_updated","href":"shipments/shipmentdeliverystatusupdatedwebhook","openApiOperationId":"shipmentDeliveryStatusUpdatedWebhook","summary":"Shipment delivery status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/shipment.delivery_status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/shipmentdeliverystatusupdatedwebhook"}],"panels":[]}]},"httpPath":"shipment.delivery_status_updated"}],"content":{"contentType":"group","meta":{"name":"Shipments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipments","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to shipments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shipments","summary":"List shipments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipments/listshipments","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"shipment.status_updated","summary":"Shipment status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/shipmentstatusupdatedwebhook","deprecated":false},{"title":"shipment.delivery_status_updated","summary":"Shipment delivery status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/shipmentdeliverystatusupdatedwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Warehouses","link":"/merchant-api-v2/mapi_v2_oas31/warehouses","routeSlug":"/merchant-api-v2/mapi_v2_oas31/warehouses","items":[{"label":"List warehouses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/warehouses/listwarehouses","routeSlug":"/merchant-api-v2/mapi_v2_oas31/warehouses/listwarehouses","metadata":{"seo":{"title":"List warehouses","description":"Returns all warehouses available to the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWarehouses","name":"List warehouses","isWebhook":false,"pointer":"/paths/~1warehouses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List warehouses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all warehouses available to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API overview above for details on how pagination works."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"Number of items to return per page (for pagination)"}],"pointer":"/paths/~1warehouses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/warehouses","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/warehouses","href":"warehouses/listwarehouses","openApiOperationId":"listWarehouses","summary":"List warehouses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of warehouses","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"401","description":"Authentication required - the request lacks valid authentication credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Access denied - the authenticated user doesn't have permission to access the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/403/content/application~1json/examples/default"]},{"code":"429","description":"Too many requests - rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/429/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/429/content/application~1json/examples/default"]}],"pointer":"/paths/~1warehouses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/403/content/application~1json/examples/default"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/429/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1warehouses/get/responses/429/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/listwarehouses"}],"panels":[]}]},"httpPath":"/warehouses"}],"content":{"contentType":"group","meta":{"name":"Warehouses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Warehouses","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to warehouses"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/warehouses","summary":"List warehouses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouses/listwarehouses","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/merchant-api-v2/mapi_v2_oas31/webhooks","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks","items":[{"label":"Order status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/orderstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/orderstatusupdatedwebhook","metadata":{"seo":{"title":"Order status updated webhook","description":"Triggered when an order status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderStatusUpdatedWebhook","name":"Order status updated webhook","isWebhook":true,"pointer":"/paths/order.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an order status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/order.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"schemaId":"components/schemas/WebhookOrder","pointer":"/paths/order.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"responseCodes":["200","422"],"pointer":"order.status_updated","href":"webhooks/orderstatusupdatedwebhook","openApiOperationId":"orderStatusUpdatedWebhook","summary":"Order status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"},{"code":"422","description":"Webhook payload validation failed"}],"pointer":"/paths/order.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/orderstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"order.status_updated"},{"label":"Shipment status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/shipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/shipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Shipment status updated webhook","description":"Triggered when a shipment status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentStatusUpdatedWebhook","name":"Shipment status updated webhook","isWebhook":true,"pointer":"/paths/shipment.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a shipment status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/shipment.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"schemaId":"components/schemas/WebhookShipment","pointer":"/paths/shipment.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"shipment.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"responseCodes":["200"],"pointer":"shipment.status_updated","href":"webhooks/shipmentstatusupdatedwebhook","openApiOperationId":"shipmentStatusUpdatedWebhook","summary":"Shipment status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/shipment.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/shipmentstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"shipment.status_updated"},{"label":"Shipment delivery status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/shipmentdeliverystatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/shipmentdeliverystatusupdatedwebhook","metadata":{"seo":{"title":"Shipment delivery status updated webhook","description":"Triggered when a shipment delivery status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentDeliveryStatusUpdatedWebhook","name":"Shipment delivery status updated webhook","isWebhook":true,"pointer":"/paths/shipment.delivery_status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment delivery status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a shipment delivery status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/shipment.delivery_status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"schemaId":"components/schemas/WebhookShipment","pointer":"/paths/shipment.delivery_status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"shipment.delivery_status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"responseCodes":["200"],"pointer":"shipment.delivery_status_updated","href":"webhooks/shipmentdeliverystatusupdatedwebhook","openApiOperationId":"shipmentDeliveryStatusUpdatedWebhook","summary":"Shipment delivery status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/shipment.delivery_status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/shipmentdeliverystatusupdatedwebhook"}],"panels":[]}]},"httpPath":"shipment.delivery_status_updated"},{"label":"Restocking shipment status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/restockingshipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/restockingshipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Restocking shipment status updated webhook","description":"Triggered when a restocking shipment status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restockingShipmentStatusUpdatedWebhook","name":"Restocking shipment status updated webhook","isWebhook":true,"pointer":"/paths/restocking_shipment.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restocking shipment status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a restocking shipment status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/restocking_shipment.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"schemaId":"components/schemas/WebhookRestockingShipment","pointer":"/paths/restocking_shipment.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"restocking_shipment.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"responseCodes":["200"],"pointer":"restocking_shipment.status_updated","href":"webhooks/restockingshipmentstatusupdatedwebhook","openApiOperationId":"restockingShipmentStatusUpdatedWebhook","summary":"Restocking shipment status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookRestockingShipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRestockingShipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/restocking_shipment.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/restockingshipmentstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"restocking_shipment.status_updated"},{"label":"Return status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/returnstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/returnstatusupdatedwebhook","metadata":{"seo":{"title":"Return status updated webhook","description":"Triggered when a return status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnStatusUpdatedWebhook","name":"Return status updated webhook","isWebhook":true,"pointer":"/paths/return.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a return status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/return.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"schemaId":"components/schemas/WebhookReturn","pointer":"/paths/return.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"return.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"responseCodes":["200"],"pointer":"return.status_updated","href":"webhooks/returnstatusupdatedwebhook","openApiOperationId":"returnStatusUpdatedWebhook","summary":"Return status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookReturn","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookReturn"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/return.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/returnstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"return.status_updated"},{"label":"Inventory transfer order status updated webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v2/mapi_v2_oas31/webhooks/inventorytransferorderstatusupdatedwebhook","routeSlug":"/merchant-api-v2/mapi_v2_oas31/webhooks/inventorytransferorderstatusupdatedwebhook","metadata":{"seo":{"title":"Inventory transfer order status updated webhook","description":"Triggered when an inventory transfer order status changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inventoryTransferOrderStatusUpdatedWebhook","name":"Inventory transfer order status updated webhook","isWebhook":true,"pointer":"/paths/inventory_transfer_order.status_updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory transfer order status updated webhook","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an inventory transfer order status changes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-hive-signature","in":"header","schemaId":"schema_32","description":"HMAC-SHA256 signature of the request body using your API token as the key","required":true}],"pointer":"/paths/inventory_transfer_order.status_updated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"schemaId":"components/schemas/WebhookInventoryTransferOrder","pointer":"/paths/inventory_transfer_order.status_updated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"inventory_transfer_order.status_updated","servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-hive-signature","in":"header","required":true,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"responseCodes":["200"],"pointer":"inventory_transfer_order.status_updated","href":"webhooks/inventorytransferorderstatusupdatedwebhook","openApiOperationId":"inventoryTransferOrderStatusUpdatedWebhook","summary":"Inventory transfer order status updated webhook"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","description":"Mock server","isMockServer":true},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}],"schemaId":"components/schemas/WebhookInventoryTransferOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookInventoryTransferOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook received successfully"}],"pointer":"/paths/inventory_transfer_order.status_updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/inventorytransferorderstatusupdatedwebhook"}],"panels":[]}]},"httpPath":"inventory_transfer_order.status_updated"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Webhook event notifications"}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"order.status_updated","summary":"Order status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/orderstatusupdatedwebhook","deprecated":false},{"title":"shipment.status_updated","summary":"Shipment status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/shipmentstatusupdatedwebhook","deprecated":false},{"title":"shipment.delivery_status_updated","summary":"Shipment delivery status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/shipmentdeliverystatusupdatedwebhook","deprecated":false},{"title":"restocking_shipment.status_updated","summary":"Restocking shipment status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/restockingshipmentstatusupdatedwebhook","deprecated":false},{"title":"return.status_updated","summary":"Return status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/returnstatusupdatedwebhook","deprecated":false},{"title":"inventory_transfer_order.status_updated","summary":"Inventory transfer order status updated webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/inventorytransferorderstatusupdatedwebhook","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"properties":{"city":{"description":"City name","type":"string","minLength":1},"company":{"description":"Company name","type":["string","null"]},"country_code":{"$ref":"#/components/schemas/CountryCode"},"email":{"description":"Email address","type":["string","null"],"format":"email"},"first_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1},"full_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's full name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1},"last_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1},"line1":{"description":"Customer's address line 1","type":"string","minLength":1},"line2":{"description":"Customer's address line 2","type":["string","null"]},"parcel_point_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel point ID - see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/service-points"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sendcloud service points"},"children":[]}]}]}]}],"type":["string","null"]},"phone":{"description":"Customer's phone number","type":["string","null"]},"postal_code":{"description":"Customer's postal code","type":"string","minLength":1},"province_or_state_code":{"description":"State or province code. For US addresses, this should be the 2-letter state code (e.g., CA, NY, TX).\nFor other countries, this should be the appropriate province/state/region code.\nExamples: CA (California), NY (New York), ON (Ontario), BE (Berlin)\n","type":["string","null"]}},"required":["city","country_code","line1","postal_code"],"anyOf":[{"required":["first_name"],"properties":{"first_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's first name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1}}},{"required":["last_name"],"properties":{"last_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's last name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1}}},{"required":["full_name"],"properties":{"full_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's full name - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted"},"children":[]}]}]}],"type":["string","null"],"minLength":1}}}],"type":"object","examples":[{"city":"Berlin","company":"Hive GmbH","country_code":"DE","email":"customer@example.com","first_name":"Anna","last_name":"Musterfrau","line1":"Alexanderplatz 1","line2":"Apt 5","phone":"+491234567890","postal_code":"10178","province_or_state_code":"BE","full_name":"Anna Musterfrau","parcel_point_id":"SC-12345"}]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schema that supports multiple error formats:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation errors with field-specific messages (legacy format for backward compatibility)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General errors with messages and optional metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI validation errors with detailed information"},"children":[]}]}]}]}],"properties":{"errors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error information. Can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with field names as keys and error arrays as values (for validation errors)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of error objects with message, code, and optional metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of strings (for simple error messages)"},"children":[]}]}]}]}],"oneOf":[{"type":"object","description":"Field-specific validation errors (legacy format)","additionalProperties":{"type":"array","items":{"type":"string"}}},{"type":"array","description":"List of error objects or simple error messages","items":{"oneOf":[{"type":"string","description":"Simple error message"},{"type":"object","description":"Detailed error object","properties":{"message":{"description":"Human-readable error message","type":"string"},"code":{"description":"Machine-readable error code","type":"string"},"pointer":{"description":"JSON pointer to the location of the error (for OpenAPI validation errors)","type":"string"}},"required":["message"]}]}}]},"success":{"description":"Indicates if the request was successful","type":"boolean"},"title":{"description":"A brief, human-readable message about the error","type":"string"},"status":{"description":"HTTP status code","type":"integer","format":"int32"}},"required":["errors"],"type":"object"}},"components/schemas/InventoryBatchSettings":{"id":"components/schemas/InventoryBatchSettings","kind":"json-schema","title":"InventoryBatchSettings","data":{"description":"Inventory batch settings for a merchant or specific SKU.","type":"object","required":["id","batch_priority","b2c_shelf_life_in_weeks","b2b_shelf_life_in_weeks","ito_shelf_life_in_weeks","kit_shelf_life_in_weeks","sku_id","is_merchant_default"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier"},"batch_priority":{"type":"string","enum":["first_expired_first_out","first_produced_first_out"],"description":"Priority strategy for batch selection"},"b2c_shelf_life_in_weeks":{"type":["integer","null"],"description":"Minimum remaining shelf life in weeks for B2C orders"},"b2b_shelf_life_in_weeks":{"type":["integer","null"],"description":"Minimum remaining shelf life in weeks for B2B orders"},"ito_shelf_life_in_weeks":{"type":["integer","null"],"description":"Minimum remaining shelf life in weeks for inventory transfer orders"},"kit_shelf_life_in_weeks":{"type":["integer","null"],"description":"Minimum remaining shelf life in weeks for kitting"},"is_merchant_default":{"type":"boolean","description":"Whether this is the merchant's default settings (true) or SKU-specific (false)"},"sku_id":{"type":["integer","null"],"format":"int64","description":"SKU ID if this is a SKU-specific setting, null for merchant default"}}}},"components/schemas/InventoryTransaction":{"id":"components/schemas/InventoryTransaction","kind":"json-schema","title":"InventoryTransaction","data":{"description":"Represents a change in inventory levels for a SKU.","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the inventory transaction."},"action":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of action that triggered this transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include: storage_box_add_manually, storage_box_reduce_manually,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order_reserved, order_shipped, return_restocked, inventory_adjustment, etc."},"children":[]}]}]}]},"sku_id":{"type":"integer","format":"int64","description":"ID of the SKU associated with this transaction."},"inventory_batch_id":{"type":["integer","null"],"format":"int64","description":"ID of the inventory batch involved in the transaction, if applicable."},"warehouse_id":{"type":["integer","null"],"format":"int64","description":"ID of the warehouse where the transaction took place, if known."},"source_category":{"type":["string","null"],"description":"The inventory category from which stock was moved (e.g., \"available\", \"reserved\", \"damaged\")."},"destination_category":{"type":["string","null"],"description":"The inventory category to which stock was moved (e.g., \"available\", \"reserved\", \"damaged\")."},"source_inventory_change":{"type":"integer","description":"The quantity change in the source category (typically negative when stock is moved out)."},"destination_inventory_change":{"type":"integer","description":"The quantity change in the destination category (typically positive when stock is moved in)."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the transaction was recorded."},"sku":{"type":["object","null"],"description":"Summary of the SKU involved in the transaction.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the SKU."},"merchant_sku":{"type":["string","null"],"description":"The merchant's internal SKU code."},"name":{"type":["string","null"],"description":"Display name of the SKU."}}},"inventory_batch":{"type":["object","null"],"description":"Summary of the inventory batch involved in the transaction, if applicable.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the inventory batch."},"name":{"type":["string","null"],"description":"Name or identifier of the batch (e.g., lot number, expiry date).","deprecated":true},"lot_number":{"type":["string","null"],"description":"Lot number of the batch."},"production_date":{"type":["string","null"],"format":"date","description":"Production date of the batch."},"expiry_date":{"type":["string","null"],"format":"date","description":"Expiry date of the batch."}}}},"required":["id","sku_id","source_inventory_change","destination_inventory_change","created_at"],"examples":[{"id":12345,"action":"storage_box_add_manually","sku_id":1001,"inventory_batch_id":null,"warehouse_id":7,"source_category":null,"destination_category":"available","source_inventory_change":0,"destination_inventory_change":50,"created_at":"2023-10-01T12:00:00Z","sku":{"id":1001,"merchant_sku":"SKU-001","name":"T-Shirt Black M"},"inventory_batch":null}]}},"components/schemas/InventoryBatch":{"id":"components/schemas/InventoryBatch","kind":"json-schema","title":"InventoryBatch","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory batch returned by the create, block, and unblock endpoints."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SkuInventoryBatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it does not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked_quantities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"blocked":{"description":"Whether this batch has pending blocking issues that prevent fulfillment","type":"boolean"},"expiry_date":{"description":"Expiration date of the batch (ISO8601 date, read-only)","type":["string","null"],"format":"date"},"id":{"description":"Hive unique ID for the batch (read-only)","type":"integer"},"lot_number":{"description":"Lot number for the batch (read-only)","type":["string","null"]},"name":{"description":"Name of the batch (read-only)","type":"string","deprecated":true},"production_date":{"description":"Production date of the batch (ISO8601 date, read-only)","type":["string","null"],"format":"date"},"status":{"description":"Status of the batch (active or archived)","type":"string","enum":["active","archived"]},"tracking_code":{"description":"Tracking code (read-only)","type":["string","null"],"deprecated":true}},"required":["blocked","expiry_date","id","lot_number","production_date","status"],"type":"object","examples":[{"blocked":false,"expiry_date":"2024-12-31","id":1,"lot_number":"LOT-001","name":"Batch-001","production_date":"2024-01-15","status":"active","tracking_code":"BATCH-TRACK-001"}]}},"components/schemas/InventoryBatchBlockRequest":{"id":"components/schemas/InventoryBatchBlockRequest","kind":"json-schema","title":"InventoryBatchBlockRequest","data":{"description":"Request body for blocking an inventory batch","properties":{"notes":{"description":"Optional notes explaining why the batch is being blocked (e.g., quality issue description)","type":["string","null"]},"user_email":{"description":"Email of the merchant user performing the block action. Must belong to the merchant.","type":"string","format":"email"}},"required":["user_email"],"type":"object","examples":[{"user_email":"warehouse-manager@merchant.com","notes":"Quality issue detected during inspection"}]}},"components/schemas/InventoryBatchCreate":{"id":"components/schemas/InventoryBatchCreate","kind":"json-schema","title":"InventoryBatchCreate","data":{"description":"Request body for creating an inventory batch","type":"object","properties":{"lot_number":{"description":"Lot number for the batch","type":["string","null"],"examples":["LOT-2024-001"]},"production_date":{"description":"Production date of the batch (ISO8601 date)","type":["string","null"],"format":"date","examples":["2024-01-15"]},"expiry_date":{"description":"Expiration date of the batch (ISO8601 date)","type":["string","null"],"format":"date","examples":["2025-12-31"]}},"examples":[{"lot_number":"LOT-2024-001","production_date":"2024-01-15","expiry_date":"2025-12-31"}]}},"components/schemas/InventoryBatchUnblockRequest":{"id":"components/schemas/InventoryBatchUnblockRequest","kind":"json-schema","title":"InventoryBatchUnblockRequest","data":{"description":"Request body for unblocking an inventory batch","properties":{"user_email":{"description":"Email of the merchant user performing the unblock action. Must belong to the merchant.","type":"string","format":"email"}},"required":["user_email"],"type":"object","examples":[{"user_email":"warehouse-manager@merchant.com"}]}},"components/schemas/InventoryTransferOrder":{"id":"components/schemas/InventoryTransferOrder","kind":"json-schema","title":"InventoryTransferOrder","data":{"properties":{"completed_at":{"description":"When the inventory transfer order was completed","readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"description":"When the inventory transfer order was created","format":"date-time","type":"string","readOnly":true},"destination_id":{"description":"The ID of the destination warehouse","format":"int64","type":"integer"},"documents":{"description":"List of documents associated with the inventory transfer order","items":{"$ref":"#/components/schemas/InventoryTransferOrderDocument"},"type":"array"},"id":{"description":"Hive's unique identifier for this inventory transfer order","format":"int64","type":"integer","readOnly":true},"items":{"description":"List of items in the inventory transfer order","items":{"$ref":"#/components/schemas/InventoryTransferOrderItem"},"type":"array"},"order":{"$ref":"#/components/schemas/InventoryTransferOrderReference"},"order_notes":{"description":"Notes for the inventory transfer order","type":["string","null"]},"origin_id":{"description":"The ID of the origin warehouse","format":"int64","type":"integer"},"restocking_shipments":{"description":"List of restocking shipments associated with the inventory transfer order","items":{"$ref":"#/components/schemas/InventoryTransferOrderRestockingShipment"},"type":"array"},"shipments":{"description":"List of shipments associated with the inventory transfer order","items":{"$ref":"#/components/schemas/InventoryTransferOrderShipment"},"type":"array"},"status":{"$ref":"#/components/schemas/InventoryTransferOrderStatus"},"updated_at":{"description":"When the inventory transfer order was last updated","format":"date-time","type":"string","readOnly":true}},"required":["created_at","destination_id","documents","id","items","order","origin_id","restocking_shipments","shipments","status","updated_at"],"type":"object","examples":[{"id":297,"status":"processing","created_at":"2025-06-05T15:15:12.256+02:00","completed_at":null,"order":{"id":1195780,"status":"processing"},"origin_id":4,"destination_id":2,"order_notes":"","documents":[],"restocking_shipments":[{"id":1916,"status":"created","estimated_arrival_date":null,"tracking_code":null,"tracking_url":null,"items":[]}],"shipments":[{"id":684202,"status":"in_packing","issues":[],"items":[],"restocking_shipment":{"id":1916,"status":"created","estimated_arrival_date":null,"tracking_code":null,"tracking_url":null,"items":[]}}],"items":[{"id":427,"quantity":10,"sku_id":161820,"sku_code":"41827199320226-empty","inventory_batch":{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05"},"inventory_batches":[{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05","quantity":3},{"id":123457,"name":"Batch-002","expiry_date":"2025-09-15","quantity":7}]}],"updated_at":"2025-06-05T16:20:15.300+02:00"}]}},"components/schemas/InventoryTransferOrderCreate":{"id":"components/schemas/InventoryTransferOrderCreate","kind":"json-schema","title":"InventoryTransferOrderCreate","data":{"properties":{"destination_id":{"description":"The ID of the destination warehouse","format":"int64","type":"integer"},"items":{"description":"List of items for the inventory transfer order","items":{"properties":{"inventory_batch_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory_batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. If provided without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory_batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the batch is assigned the full item quantity."},"children":[]}]}]}],"deprecated":true,"anyOf":[{"type":"integer","format":"int64"},{"type":"null"}]},"inventory_batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory batches to pin to this item, each with an allocated quantity. The sum of all batch quantities must equal the parent item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each individual batch quantity must not exceed the parent item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The inventory batch must belong to the same SKU as the item. Replaces the deprecated scalar "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory_batch_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","properties":{"inventory_batch_id":{"description":"The ID of the inventory batch. Must belong to the same SKU as the item.","type":"integer","format":"int64"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity to allocate from this batch. Must not exceed the parent item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — requests that violate this constraint will be rejected with a 422 error."},"children":[]}]}]}],"type":"integer","format":"int32","minimum":1}},"required":["inventory_batch_id","quantity"]}},"quantity":{"description":"The quantity of this item to transfer","format":"int32","type":"integer","minimum":1},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"format":"int64","type":"integer"}},"required":["quantity"],"anyOf":[{"required":["sku_id"]},{"required":["sku_code"]}],"type":"object"},"type":"array"},"order_notes":{"description":"Notes for the inventory transfer order","type":"string"},"origin_id":{"description":"The ID of the origin warehouse","format":"int64","type":"integer"}},"required":["destination_id","items","origin_id"],"type":"object","examples":[{"origin_id":39,"destination_id":38,"order_notes":"","items":[{"quantity":10,"sku_id":586004,"inventory_batches":[{"inventory_batch_id":123456,"quantity":3},{"inventory_batch_id":123457,"quantity":7}]}]}]}},"components/schemas/InventoryTransferOrderDocument":{"id":"components/schemas/InventoryTransferOrderDocument","kind":"json-schema","title":"InventoryTransferOrderDocument","data":{"properties":{"id":{"description":"Document ID","format":"int64","type":"integer"},"name":{"description":"Document name","type":["string","null"]},"url":{"description":"Document URL","type":"string"}},"required":["id","name","url"],"type":"object","examples":[{"id":12345,"name":"transfer_receipt.pdf","url":"https://docs.hive.app/transfers/12345/receipt.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3"}]}},"components/schemas/InventoryTransferOrderInventoryBatch":{"id":"components/schemas/InventoryTransferOrderInventoryBatch","kind":"json-schema","title":"InventoryTransferOrderInventoryBatch","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory_batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (plural) instead. Returns only the first batch for backward compatibility."},"children":[]}]}]}],"deprecated":true,"properties":{"expiry_date":{"description":"Expiration date of the batch","type":["string","null"],"format":"date"},"id":{"description":"Batch ID","format":"int64","type":"integer"},"name":{"description":"Batch name","type":"string","deprecated":true}},"required":["id","name"],"examples":[{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05"}]}},"components/schemas/InventoryTransferOrderInventoryBatchWithQuantity":{"id":"components/schemas/InventoryTransferOrderInventoryBatchWithQuantity","kind":"json-schema","title":"InventoryTransferOrderInventoryBatchWithQuantity","data":{"type":"object","description":"An inventory batch pinned to an ITO item, with the allocated quantity.","properties":{"id":{"description":"Batch ID","format":"int64","type":"integer"},"name":{"description":"Batch name","type":"string","deprecated":true},"expiry_date":{"description":"Expiration date of the batch","type":["string","null"],"format":"date"},"quantity":{"description":"Quantity allocated from this batch","format":"int32","type":"integer","minimum":1}},"required":["id","name","quantity"],"examples":[{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05","quantity":5}]}},"components/schemas/InventoryTransferOrderItem":{"id":"components/schemas/InventoryTransferOrderItem","kind":"json-schema","title":"InventoryTransferOrderItem","data":{"properties":{"id":{"description":"Hive's unique identifier for this item","format":"int64","type":"integer","readOnly":true},"inventory_batch":{"$ref":"#/components/schemas/InventoryTransferOrderInventoryBatch"},"inventory_batches":{"description":"Inventory batches pinned to this item, each with an allocated quantity.","type":"array","items":{"$ref":"#/components/schemas/InventoryTransferOrderInventoryBatchWithQuantity"}},"quantity":{"description":"The quantity of this item to transfer","format":"int32","type":"integer","minimum":1},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"format":"int64","type":"integer"}},"required":["id","quantity","sku_code","sku_id","inventory_batches"],"type":"object","examples":[{"id":427,"quantity":10,"sku_id":161820,"sku_code":"41827199320226-empty","inventory_batch":{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05"},"inventory_batches":[{"id":123456,"name":"Batch-001","expiry_date":"2025-06-05","quantity":3},{"id":123457,"name":"Batch-002","expiry_date":"2025-09-15","quantity":7}]}]}},"components/schemas/InventoryTransferOrderPatch":{"id":"components/schemas/InventoryTransferOrderPatch","kind":"json-schema","title":"InventoryTransferOrderPatch","data":{"properties":{"destination_id":{"description":"The ID of the destination warehouse","format":"int64","type":"integer"},"order_notes":{"description":"Notes for the inventory transfer order","type":"string"},"origin_id":{"description":"The ID of the origin warehouse","format":"int64","type":"integer"}},"type":"object","examples":[{"order_notes":"Updated notes","destination_id":3}]}},"components/schemas/InventoryTransferOrderReference":{"id":"components/schemas/InventoryTransferOrderReference","kind":"json-schema","title":"InventoryTransferOrderReference","data":{"type":["object","null"],"properties":{"id":{"description":"Order ID","format":"int64","type":["integer","null"]},"status":{"description":"Order status","type":["string","null"]}},"examples":[{"id":1195780,"status":"processing"}]}},"components/schemas/InventoryTransferOrderRestockingShipment":{"id":"components/schemas/InventoryTransferOrderRestockingShipment","kind":"json-schema","title":"InventoryTransferOrderRestockingShipment","data":{"properties":{"estimated_arrival_date":{"description":"Estimated arrival date","type":["string","null"],"format":"date"},"id":{"description":"Restocking shipment ID","format":"int64","type":"integer"},"items":{"description":"Items in the restocking shipment","items":{"$ref":"#/components/schemas/RestockingShipmentItem"},"type":"array"},"status":{"description":"Restocking shipment status","type":"string"},"tracking_code":{"description":"Tracking code","type":["string","null"]},"tracking_url":{"description":"Tracking URL","type":["string","null"]}},"required":["id","items","status"],"type":"object","examples":[{"id":1916,"status":"created","estimated_arrival_date":null,"tracking_code":null,"tracking_url":null,"items":[]}]}},"components/schemas/InventoryTransferOrderShipment":{"id":"components/schemas/InventoryTransferOrderShipment","kind":"json-schema","title":"InventoryTransferOrderShipment","data":{"properties":{"id":{"description":"Shipment ID","format":"int64","type":"integer"},"issues":{"description":"Issues with the shipment","items":{"type":"object"},"type":"array"},"items":{"description":"Items in the shipment","items":{"$ref":"#/components/schemas/InventoryTransferOrderShipmentItem"},"type":"array"},"restocking_shipment":{"$ref":"#/components/schemas/InventoryTransferOrderRestockingShipment"},"status":{"description":"Shipment status","type":"string"}},"required":["id","issues","items","status"],"type":"object","examples":[{"id":684202,"status":"in_packing","issues":[],"items":[]}]}},"components/schemas/InventoryTransferOrderShipmentItem":{"id":"components/schemas/InventoryTransferOrderShipmentItem","kind":"json-schema","title":"InventoryTransferOrderShipmentItem","data":{"properties":{"id":{"description":"Shipment item ID","format":"int64","type":"integer"},"quantity":{"description":"Quantity in the shipment","format":"int32","type":"integer","minimum":1},"sku_code":{"description":"The merchant's SKU code","type":"string"},"sku_id":{"description":"The SKU ID","format":"int64","type":"integer"}},"required":["id","quantity","sku_code","sku_id"],"type":"object","examples":[{"id":451386,"quantity":1,"sku_id":161820,"sku_code":"41827199320226-empty"}]}},"components/schemas/OrderBase":{"id":"components/schemas/OrderBase","kind":"json-schema","title":"OrderBase","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base Order schema shared by mutation responses (create/update/cancel) and webhook payloads."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read responses use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which extends this schema with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_blocking_issues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"b2b_instructions":{"description":"B2B packing and shipping instructions for B2B orders. Null if order is not B2B or has no instructions set.","oneOf":[{"$ref":"#/components/schemas/OrderB2bInstructions"},{"type":"null"}]},"carrier_preference":{"description":"The preferred carrier to use for delivering this order","type":["string","null"]},"created_at":{"description":"When the order was created. Will default to current time if omitted.","format":"date-time","type":"string","readOnly":true},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"custom_metadata":{"additionalProperties":true,"description":"A JSON object with custom metadata","type":["object","null"]},"customer_order_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number which your customer sees. In case this is not the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"external_created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the order was originally created/placed by the customer. This can be different from created_at when doing bulk imports or when there's a delay between order placement and API submission."},"children":[]}]}]}],"format":"date-time","type":["string","null"]},"documents":{"description":"Documents attached to this order (excluding system-generated documents). Only present for B2B orders.","items":{"$ref":"#/components/schemas/OrderDocument"},"type":"array"},"financial_status":{"$ref":"#/components/schemas/OrderFinancialStatus"},"id":{"description":"Hive's unique identifier for this order","format":"int64","type":"integer","readOnly":true},"items":{"description":"List of items in the order","items":{"$ref":"#/components/schemas/OrderItemResponse"},"type":"array"},"merchant_note":{"description":"Internal note from the merchant about this order","type":["string","null"]},"merchant_order_id":{"description":"An ID that uniquely identifies this order within the sales channel. Must be unique per sales channel.","type":"string"},"payment_method":{"description":"The payment method used for this order","type":["string","null"]},"po_number":{"description":"Purchase order number for B2B orders","type":["string","null"]},"recipient_instructions":{"description":"Delivery or handling instructions for the recipient","type":["string","null"]},"sales_channel_id":{"description":"The ID of the sales channel this order belongs to","format":"int64","type":"integer"},"shipping_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"fulfillment_status":{"$ref":"#/components/schemas/OrderFulfillmentStatus"},"tags":{"description":"String tags for this order","type":["array","null"],"items":{"type":"string"}},"total_net_refunds_in_cents":{"description":"Net refunds in cents (total refunded minus taxes)","format":"int32","type":"integer","minimum":0},"total_net_revenue_in_cents":{"description":"Net revenue in cents (amount paid minus taxes)","format":"int32","type":"integer","minimum":0},"total_price_in_cents":{"description":"Total price paid in cents","format":"int32","type":"integer","minimum":0},"total_tax_in_cents":{"description":"Total tax paid in cents","format":"int32","type":"integer","minimum":0},"total_tax_refunds_in_cents":{"description":"Total tax in the refunded amount in cents","format":"int32","type":"integer","minimum":0},"updated_at":{"description":"When the order was last updated","format":"date-time","type":"string","readOnly":true}},"required":["id","items","merchant_order_id","sales_channel_id","carrier_preference","fulfillment_status","financial_status","total_price_in_cents","currency","created_at","total_net_refunds_in_cents","total_net_revenue_in_cents","total_tax_in_cents","total_tax_refunds_in_cents","updated_at"],"type":"object","examples":[{"id":123456,"items":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"quantity":2,"sku_code":"SKU-001","sku_id":1001}],"merchant_order_id":"ORD-1001","sales_channel_id":10,"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"},"fulfillment_status":"waiting_for_picking","financial_status":"paid","created_at":"2023-10-01T12:00:00Z","currency":"EUR","payment_method":"credit_card","tags":["priority","gift"],"total_price_in_cents":3000,"total_tax_in_cents":570,"total_net_revenue_in_cents":2430,"total_net_refunds_in_cents":0,"total_tax_refunds_in_cents":0,"custom_metadata":{"gift_message":"Happy Birthday!"},"customer_order_number":"CUST-ORD-2023-01","carrier_preference":"DHL","external_created_at":"2023-10-01T10:30:00Z","updated_at":"2023-10-01T14:30:00Z"}]}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order schema returned by GET/LIST endpoints. Extends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_blocking_issues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is only populated by read endpoints (not by create/update/cancel responses or webhooks)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/OrderBase"},{"type":"object","properties":{"has_blocking_issues":{"description":"Whether the order has any unresolved external issues blocking fulfillment.","type":"boolean","readOnly":true}}}],"examples":[{"id":123456,"items":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"quantity":2,"sku_code":"SKU-001","sku_id":1001}],"merchant_order_id":"ORD-1001","sales_channel_id":10,"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"},"fulfillment_status":"waiting_for_picking","has_blocking_issues":false,"financial_status":"paid","created_at":"2023-10-01T12:00:00Z","currency":"EUR","payment_method":"credit_card","tags":["priority","gift"],"total_price_in_cents":3000,"total_tax_in_cents":570,"total_net_revenue_in_cents":2430,"total_net_refunds_in_cents":0,"total_tax_refunds_in_cents":0,"custom_metadata":{"gift_message":"Happy Birthday!"},"customer_order_number":"CUST-ORD-2023-01","carrier_preference":"DHL","external_created_at":"2023-10-01T10:30:00Z","updated_at":"2023-10-01T14:30:00Z"}]}},"components/schemas/OrderCreate":{"id":"components/schemas/OrderCreate","kind":"json-schema","title":"OrderCreate","data":{"properties":{"b2b_instructions":{"description":"B2B packing and shipping instructions. Only applicable to B2B orders (orders tagged with a B2B tag).","allOf":[{"$ref":"#/components/schemas/OrderB2bInstructionsInput"},{"required":["delivery_instruction"]}]},"carrier_preference":{"description":"The preferred carrier to use for delivering this order","type":["string","null"]},"currency":{"description":"3-letter ISO 4217 currency code. Defaults to the merchant's primary currency if omitted.","$ref":"#/components/schemas/CurrencyCode"},"custom_metadata":{"additionalProperties":true,"description":"A JSON object with custom metadata","type":["object","null"]},"customer_order_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number which your customer sees. In case this is not the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"documents":{"description":"Documents to attach to the order. Only applicable to B2B orders. Maximum 5 documents. Ignored for non-B2B orders.","items":{"$ref":"#/components/schemas/OrderDocumentInput"},"type":"array","maxItems":5},"external_created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the order was originally created/placed by the customer. This can be different from created_at when doing bulk imports or when there's a delay between order placement and API submission."},"children":[]}]}]}],"format":"date-time","type":["string","null"]},"financial_status":{"$ref":"#/components/schemas/OrderFinancialStatus"},"items":{"description":"List of items in the order (see OrderItem)","items":{"$ref":"#/components/schemas/OrderItem"},"type":"array","minItems":1},"merchant_note":{"description":"Internal note from the merchant about this order","type":["string","null"]},"merchant_order_id":{"description":"An ID that uniquely identifies this order within the sales channel. Must be unique per sales channel.","type":"string","minLength":1},"payment_method":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method used for this order. For Cash on Delivery orders, use 'COD'. When payment_method contains 'COD', total_price_in_cents must be greater than 0."},"children":[]}]}]}],"type":["string","null"]},"po_number":{"description":"Purchase order number for B2B orders","type":["string","null"]},"recipient_instructions":{"description":"Delivery or handling instructions for the recipient","type":["string","null"]},"sales_channel_id":{"description":"The ID of the sales channel this order belongs to","format":"int64","type":"integer"},"shipping_address":{"$ref":"#/components/schemas/Address"},"tags":{"description":"String tags for this order","type":["array","null"],"items":{"type":"string"}},"total_net_refunds_in_cents":{"description":"Net refunds in cents (total refunded minus taxes)","format":"int32","type":"integer","minimum":0},"total_net_revenue_in_cents":{"description":"Net revenue in cents (amount paid minus taxes)","format":"int32","type":"integer","minimum":0},"total_price_in_cents":{"description":"Total price paid in cents. Required and must be greater than 0 for COD (Cash on Delivery) orders, as this value is transmitted to the carrier as the amount to collect from the customer at delivery.","format":"int32","type":"integer","minimum":0},"total_tax_in_cents":{"description":"Total tax paid in cents","format":"int32","type":"integer","minimum":0},"total_tax_refunds_in_cents":{"description":"Total tax in the refunded amount in cents","format":"int32","type":"integer","minimum":0}},"required":["items","merchant_order_id","sales_channel_id","shipping_address"],"type":"object","examples":[{"items":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"quantity":2,"sku_code":"SKU-001","sku_id":1001}],"merchant_order_id":"ORD-1001","sales_channel_id":10,"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"},"currency":"EUR","payment_method":"credit_card","tags":["priority","gift"],"total_price_in_cents":3000,"total_tax_in_cents":570,"total_net_revenue_in_cents":2430,"total_net_refunds_in_cents":0,"total_tax_refunds_in_cents":0,"custom_metadata":{"gift_message":"Happy Birthday!"},"customer_order_number":"CUST-ORD-2023-01","carrier_preference":"DHL","external_created_at":"2023-10-01T10:30:00Z"}]}},"components/schemas/OrderB2bInstructions":{"id":"components/schemas/OrderB2bInstructions","kind":"json-schema","title":"OrderB2bInstructions","data":{"description":"B2B packing and shipping instructions (read-only, returned in order responses)","properties":{"pallet_freight_delivery_option":{"description":"Delivery option for pallet freight shipments","type":["string","null"],"enum":["standard_delivery","fixed_date_delivery","timed_delivery","avis_delivery","fixed_time_window_delivery",null]},"fixed_delivery_date":{"description":"Requested fixed delivery date (ISO8601 date). Set for date-bearing delivery options.","type":["string","null"],"format":"date"},"fixed_delivery_time_from":{"description":"Start of the requested delivery time window, as \"HH:MM\". Set for timed and fixed-window options.","type":["string","null"]},"fixed_delivery_time_to":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the requested delivery time window, as \"HH:MM\". Set for fixed_time_window_delivery."},"children":[]}]}]}],"type":["string","null"]},"freight_offer_threshold_currency":{"description":"Currency code for freight offer threshold","oneOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"freight_offer_threshold_in_cents":{"description":"Freight offer threshold in cents","type":["integer","null"]},"freight_transport_mode":{"description":"Transport mode for freight shipments","type":["string","null"],"enum":["sea","air","rail","road",null]},"labelling_required_sku_barcode":{"description":"Whether SKU barcode labelling is required","type":"boolean"},"max_pallet_dimensions":{"description":"Whether max pallet dimensions are set","type":"boolean"},"max_pallet_height_in_mm":{"description":"Maximum pallet height in millimeters","type":["integer","null"]},"max_pallet_length_in_mm":{"description":"Maximum pallet length in millimeters","type":["integer","null"]},"max_pallet_weight":{"description":"Whether max pallet weight is set","type":"boolean"},"max_pallet_weight_in_kg":{"description":"Maximum pallet weight in kilograms","type":["number","null"]},"max_pallet_width_in_mm":{"description":"Maximum pallet width in millimeters","type":["integer","null"]},"max_parcel_dimensions":{"description":"Whether max parcel dimensions are set","type":"boolean"},"max_parcel_height_in_mm":{"description":"Maximum parcel height in millimeters","type":["integer","null"]},"max_parcel_length_in_mm":{"description":"Maximum parcel length in millimeters","type":["integer","null"]},"max_parcel_weight":{"description":"Whether max parcel weight is set","type":"boolean"},"max_parcel_weight_in_kg":{"description":"Maximum parcel weight in kilograms","type":["number","null"]},"max_parcel_width_in_mm":{"description":"Maximum parcel width in millimeters","type":["integer","null"]},"merchant_packing_labels_required":{"description":"Whether merchant-provided packing labels are required","type":"boolean"},"merchant_pickup":{"description":"Whether the merchant will pick up the order","type":"boolean"},"merchant_pickup_date":{"description":"Date for merchant pickup (ISO8601 date)","type":["string","null"],"format":"date"},"pack_in_single_sku_pallet":{"description":"Whether to pack each SKU in a separate pallet","type":"boolean"},"pack_in_single_sku_parcel":{"description":"Whether to pack each SKU in a separate parcel","type":"boolean"},"delivery_instruction":{"description":"Packing and shipping restriction type for the order","type":["string","null"],"enum":["optimized_shipping","ship_only_in_parcels","ship_only_in_pallets",null]},"repack_from_master_carton":{"description":"Whether to repack items from master cartons","type":"boolean"},"shipping_label_by_merchant":{"description":"Whether the merchant provides the shipping label","type":"boolean"}},"type":"object"}},"components/schemas/OrderB2bInstructionsInput":{"id":"components/schemas/OrderB2bInstructionsInput","kind":"json-schema","title":"OrderB2bInstructionsInput","data":{"description":"B2B packing and shipping instructions to set on order creation. Only applicable to B2B orders.","properties":{"pallet_freight_delivery_option":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery option for pallet freight shipments. This field must only be sent when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on order creation when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction == ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — missing values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return 422."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejected with 422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent with any other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Omit the field unless the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is pallet-only."},"children":[]}]}]}]}]}],"type":"string","enum":["standard_delivery","fixed_date_delivery","timed_delivery","avis_delivery","fixed_time_window_delivery"]},"fixed_delivery_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requested fixed delivery date (ISO8601 date). Only valid for the date-bearing options ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_date_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timed_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_time_window_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Must be at least 4 working days out — validated against the fulfilling warehouse's operating calendar when known, otherwise the national business-day calendar — else 422."},"children":[]}]}]}],"type":["string","null"],"format":"date"},"fixed_delivery_time_from":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the delivery time window, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_delivery_time_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pallet_freight_delivery_option"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_time_window_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"fixed_delivery_time_to":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the delivery time window, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be at least 4 hours after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_delivery_time_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", else 422."},"children":[]}]}]}],"type":["string","null"]},"freight_offer_threshold_in_cents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-accept threshold for carrier freight offers, in cents. Only valid when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction == ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sending it with any other restriction returns 422."},"children":[]}]}]}],"type":"integer"},"freight_transport_mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transport mode for freight shipments. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on order creation when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction == ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; optional otherwise."},"children":[]}]}]}],"type":"string","enum":["road","air","sea"]},"labelling_required_sku_barcode":{"type":"boolean"},"max_pallet_height_in_mm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-pallet height in millimeters. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_height_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_width_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_length_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent together — either all three as numbers (enables the pallet dimension check) or all three as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (disables it). Any other combination returns 422."},"children":[]}]}]}],"type":["integer","null"]},"max_pallet_length_in_mm":{"type":["integer","null"]},"max_pallet_weight_in_kg":{"description":"Maximum per-pallet weight in kilograms. When present (non-null), the pallet weight check is enabled automatically.","type":["number","null"]},"max_pallet_width_in_mm":{"type":["integer","null"]},"max_parcel_height_in_mm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-parcel height in millimeters. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_height_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_width_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_length_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent together — either all three as numbers (enables the parcel dimension check) or all three as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (disables it). Any other combination returns 422."},"children":[]}]}]}],"type":["integer","null"]},"max_parcel_length_in_mm":{"type":["integer","null"]},"max_parcel_weight_in_kg":{"description":"Maximum per-parcel weight in kilograms. When present (non-null), the parcel weight check is enabled automatically.","type":["number","null"]},"max_parcel_width_in_mm":{"type":["integer","null"]},"merchant_pickup":{"type":"boolean"},"merchant_pickup_date":{"type":"string","format":"date"},"pack_in_single_sku_pallet":{"type":"boolean"},"pack_in_single_sku_parcel":{"type":"boolean"},"delivery_instruction":{"description":"Packing and shipping restriction type for the order. Required on order creation.","type":"string","enum":["optimized_shipping","ship_only_in_parcels","ship_only_in_pallets"]},"repack_from_master_carton":{"type":"boolean"}},"type":"object"}},"components/schemas/OrderB2bInstructionsPatch":{"id":"components/schemas/OrderB2bInstructionsPatch","kind":"json-schema","title":"OrderB2bInstructionsPatch","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B2B packing and shipping instructions to update on an existing order. All fields are optional (partial PATCH semantics): omit a field to leave the current value unchanged. Note that fields documented as non-nullable cannot be cleared via PATCH — once set, they persist until overwritten with another value."},"children":[]}]}]}],"properties":{"pallet_freight_delivery_option":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery option for pallet freight shipments. This field must only be sent when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected with 422 when sent with any other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Omit the field unless the order is pallet-only."},"children":[]}]}]}],"type":"string","enum":["standard_delivery","fixed_date_delivery","timed_delivery","avis_delivery","fixed_time_window_delivery"]},"fixed_delivery_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requested fixed delivery date (ISO8601 date). Only valid for the date-bearing options ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_date_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timed_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_time_window_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Must be at least 4 working days out — validated against the fulfilling warehouse's operating calendar when known, otherwise the national business-day calendar — else 422."},"children":[]}]}]}],"type":["string","null"],"format":"date"},"fixed_delivery_time_from":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the delivery time window, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_delivery_time_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pallet_freight_delivery_option"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_time_window_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"fixed_delivery_time_to":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the delivery time window, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be at least 4 hours after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_delivery_time_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", else 422."},"children":[]}]}]}],"type":["string","null"]},"freight_offer_threshold_in_cents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-accept threshold for carrier freight offers, in cents. Only valid when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_instruction == ship_only_in_pallets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sending it with any other restriction returns 422."},"children":[]}]}]}],"type":"integer"},"freight_transport_mode":{"description":"Transport mode for freight shipments.","type":"string","enum":["road","air","sea"]},"labelling_required_sku_barcode":{"type":"boolean"},"max_pallet_height_in_mm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-pallet height in millimeters. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_height_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_width_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_pallet_length_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent together — either all three as numbers (enables the pallet dimension check) or all three as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (disables it). Any other combination returns 422."},"children":[]}]}]}],"type":["integer","null"]},"max_pallet_length_in_mm":{"type":["integer","null"]},"max_pallet_weight_in_kg":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-pallet weight in kilograms. When present (non-null), the pallet weight check is enabled automatically. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disables the check."},"children":[]}]}]}],"type":["number","null"]},"max_pallet_width_in_mm":{"type":["integer","null"]},"max_parcel_height_in_mm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-parcel height in millimeters. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_height_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_width_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_parcel_length_in_mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent together — either all three as numbers (enables the parcel dimension check) or all three as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (disables it). Any other combination returns 422."},"children":[]}]}]}],"type":["integer","null"]},"max_parcel_length_in_mm":{"type":["integer","null"]},"max_parcel_weight_in_kg":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum per-parcel weight in kilograms. When present (non-null), the parcel weight check is enabled automatically. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disables the check."},"children":[]}]}]}],"type":["number","null"]},"max_parcel_width_in_mm":{"type":["integer","null"]},"merchant_pickup":{"type":"boolean"},"merchant_pickup_date":{"type":"string","format":"date"},"pack_in_single_sku_pallet":{"type":"boolean"},"pack_in_single_sku_parcel":{"type":"boolean"},"delivery_instruction":{"description":"Packing and shipping restriction type for the order","type":"string","enum":["optimized_shipping","ship_only_in_parcels","ship_only_in_pallets"]},"repack_from_master_carton":{"type":"boolean"}},"type":"object"}},"components/schemas/OrderDocument":{"id":"components/schemas/OrderDocument","kind":"json-schema","title":"OrderDocument","data":{"description":"A document attached to an order","properties":{"document_type":{"description":"Type of the document","type":["string","null"],"enum":["delivery_slip","gs1_label","invoice","order_confirmation","other","packing_label","packing_list","pallet_label","parcel_label","shipping_label","sku_barcode",null]},"id":{"description":"Document ID","format":"int64","type":"integer"},"name":{"description":"Document filename","type":["string","null"]},"url":{"description":"Document download URL","type":["string","null"]}},"required":["id","name","document_type","url"],"type":"object"}},"components/schemas/OrderDocumentInput":{"id":"components/schemas/OrderDocumentInput","kind":"json-schema","title":"OrderDocumentInput","data":{"description":"A document to attach to an order","oneOf":[{"required":["document_data_uri"]},{"required":["document_url"]}],"properties":{"document_data_uri":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded data URI of the document content. Provide either this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"document_type":{"description":"Type of the document","type":["string","null"],"enum":["delivery_slip","gs1_label","invoice","order_confirmation","other","packing_label","packing_list","pallet_label","parcel_label","shipping_label","sku_barcode",null]},"document_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the document. Provide either this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_data_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"name":{"description":"Document filename","type":["string","null"]}},"type":"object"}},"components/schemas/OrderFinancialStatus":{"id":"components/schemas/OrderFinancialStatus","kind":"json-schema","title":"OrderFinancialStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Financial status of this order. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed: Payment failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid: Payment completed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: Payment is pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunded: Payment has been refunded"},"children":[]}]}]}]}],"enum":["failed","paid","pending","refunded"],"type":"string"}},"components/schemas/OrderInventoryBatch":{"id":"components/schemas/OrderInventoryBatch","kind":"json-schema","title":"OrderInventoryBatch","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An inventory batch for an order item (B2B only). On input, only id and quantity are required. On output, name and expiry_date are also included."},"children":[]}]}]}],"properties":{"id":{"description":"Hive's inventory batch ID","format":"int64","type":"integer"},"quantity":{"description":"Quantity to pick from this batch","format":"int32","type":"integer","minimum":1},"name":{"description":"Batch name (read-only, included in responses)","type":"string","readOnly":true},"expiry_date":{"description":"Expiration date of the batch (read-only, included in responses)","type":["string","null"],"format":"date","readOnly":true}},"required":["id","quantity"],"examples":[{"id":123,"quantity":5},{"id":123,"name":"Batch-001","expiry_date":"2025-12-31","quantity":5}]}},"components/schemas/OrderItem":{"id":"components/schemas/OrderItem","kind":"json-schema","title":"OrderItem","data":{"properties":{"inventory_batches":{"description":"Inventory batches to pick for this item. B2B orders only. The sum of all batch quantities must equal the item quantity. Each batch must exist and belong to the item's SKU.","type":"array","items":{"$ref":"#/components/schemas/OrderInventoryBatch"}},"merchant_item_id":{"description":"Identifier for the line item. Needs to be unique among the line items of the order.","type":"string"},"price_per_unit_in_cents":{"description":"The price per unit of this item. Defaults to 0 if omitted. Recommended for customs documents and declarations, return label generation, and required for accurate COD (Cash on Delivery) order amounts.","format":"int32","type":"integer","minimum":0,"default":0},"price_per_unit_in_cents_with_discount":{"description":"The discounted price per unit of this item","format":"int32","type":"integer","minimum":0},"quantity":{"description":"The quantity of this item in the order","format":"int32","type":"integer","minimum":1},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"format":"int64","type":"integer"}},"required":["merchant_item_id","quantity"],"anyOf":[{"required":["sku_id"]},{"required":["sku_code"]}],"type":"object","examples":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"price_per_unit_in_cents_with_discount":1200,"quantity":2,"sku_code":"SKU-001","sku_id":1001},{"merchant_item_id":"2","quantity":8,"sku_id":1002}]}},"components/schemas/OrderItemResponse":{"id":"components/schemas/OrderItemResponse","kind":"json-schema","title":"OrderItemResponse","data":{"description":"An order line item as returned by read endpoints. SKU fields are nullable because items may exist without a matched SKU.","properties":{"inventory_batches":{"description":"Inventory batches assigned to this item. B2B orders only.","type":"array","items":{"$ref":"#/components/schemas/OrderInventoryBatch"}},"merchant_item_id":{"description":"Identifier for the line item.","type":"string"},"price_per_unit_in_cents":{"format":"int32","type":"integer","minimum":0},"price_per_unit_in_cents_with_discount":{"format":"int32","type":"integer","minimum":0},"quantity":{"format":"int32","type":"integer","minimum":1},"sku_code":{"description":"The merchant's SKU identifier, or null if the item has no matched SKU","type":["string","null"]},"sku_id":{"description":"Hive's SKU identifier, or null if the item has no matched SKU","format":"int64","type":["integer","null"]}},"required":["merchant_item_id","quantity","sku_id","sku_code"],"type":"object"}},"components/schemas/OrderFulfillmentStatus":{"id":"components/schemas/OrderFulfillmentStatus","kind":"json-schema","title":"OrderFulfillmentStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current fulfillment status of the order within Hive's fulfillment process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This tracks the order's progress from confirmation through delivery. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting_for_picking: Order is confirmed and waiting to be picked in the fulfillment center"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing: Order is actively being processed (picked/packed) in the fulfillment center"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partially_shipped: Some items from the order have been shipped, but others are still pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipped: All items from the order have been shipped"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on_hold: Order is temporarily paused (e.g., payment issues, merchant request)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_pending: Order is waiting for payment confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: Order has been cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored: Order will not be fulfilled (automatically set based on external conditions)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is read-only and managed entirely by Hive based on the fulfillment process."},"children":[]}]}]}],"enum":["waiting_for_picking","processing","partially_shipped","shipped","on_hold","payment_pending","cancelled","ignored"],"type":"string","readOnly":true}},"components/schemas/OrderPatch":{"id":"components/schemas/OrderPatch","kind":"json-schema","title":"OrderPatch","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema for updating an existing order. The unique identifiers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated and will be ignored if provided in the request body."},"children":[]}]}]}],"properties":{"b2b_instructions":{"description":"B2B packing and shipping instructions. Only applicable to B2B orders.","$ref":"#/components/schemas/OrderB2bInstructionsPatch"},"carrier_preference":{"description":"The preferred carrier to use for delivering this order","type":["string","null"]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"custom_metadata":{"additionalProperties":true,"description":"A JSON object with custom metadata","type":["object","null"]},"customer_order_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number which your customer sees. In case this is not the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"documents":{"description":"Documents to attach to the order. Only applicable to B2B orders. Maximum 5 documents. Ignored for non-B2B orders.","items":{"$ref":"#/components/schemas/OrderDocumentInput"},"type":"array","maxItems":5},"external_created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the order was originally created/placed by the customer. This can be different from created_at when doing bulk imports or when there's a delay between order placement and API submission."},"children":[]}]}]}],"format":"date-time","type":"string"},"financial_status":{"$ref":"#/components/schemas/OrderFinancialStatus"},"items":{"description":"List of items in the order (see OrderItem)","items":{"$ref":"#/components/schemas/OrderItem"},"type":"array"},"merchant_note":{"description":"Internal note from the merchant about this order","type":["string","null"]},"payment_method":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method used for this order. For Cash on Delivery orders, use 'COD'. When payment_method contains 'COD', total_price_in_cents must be greater than 0."},"children":[]}]}]}],"type":"string"},"po_number":{"description":"Purchase order number for B2B orders","type":["string","null"]},"recipient_instructions":{"description":"Delivery or handling instructions for the recipient","type":["string","null"]},"shipping_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"tags":{"description":"String tags for this order","items":{"type":"string"},"type":"array"},"total_net_refunds_in_cents":{"description":"Net refunds in cents (total refunded minus taxes)","format":"int32","type":"integer","minimum":0},"total_net_revenue_in_cents":{"description":"Net revenue in cents (amount paid minus taxes)","format":"int32","type":"integer","minimum":0},"total_price_in_cents":{"description":"Total price paid in cents. Required and must be greater than 0 for COD (Cash on Delivery) orders, as this value is transmitted to the carrier as the amount to collect from the customer at delivery.","format":"int32","type":"integer","minimum":0},"total_tax_in_cents":{"description":"Total tax paid in cents","format":"int32","type":"integer","minimum":0},"total_tax_refunds_in_cents":{"description":"Total tax in the refunded amount in cents","format":"int32","type":"integer","minimum":0}},"type":"object","examples":[{"items":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"quantity":2,"sku_code":"SKU-001","sku_id":1001}],"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"},"currency":"EUR","payment_method":"credit_card","tags":["priority","gift"],"total_price_in_cents":3000,"total_tax_in_cents":570,"total_net_revenue_in_cents":2430,"total_net_refunds_in_cents":0,"total_tax_refunds_in_cents":0,"custom_metadata":{"gift_message":"Happy Birthday!"},"customer_order_number":"CUST-ORD-2023-01","carrier_preference":"DHL"}]}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"type":"object","properties":{"first_page_url":{"type":"string","description":"URL to fetch the first page of results"},"limit":{"type":"integer","description":"Number of items returned per page"},"next_page_url":{"type":["string","null"],"description":"URL to fetch the next page of results. If null, there are no more results."}},"examples":[{"first_page_url":"https://app.hive.app/merchant_api/v2/collection_of_items?limit=20","limit":20,"next_page_url":"https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"}]}},"components/schemas/RestockingShipment":{"id":"components/schemas/RestockingShipment","kind":"json-schema","title":"RestockingShipment","data":{"properties":{"arrived_at":{"description":"When the shipment was arrived","format":"date-time","type":["string","null"],"readOnly":true},"barcode":{"description":"The barcode of the shipment","type":["string","null"]},"created_at":{"description":"When the shipment was created","format":"date-time","type":"string","readOnly":true},"delivery_option":{"$ref":"#/components/schemas/RestockingShipmentDeliveryOption"},"estimated_arrival_date":{"description":"Estimated arrival date","format":"date","type":["string","null"]},"id":{"description":"Hive's unique identifier","format":"int64","type":"integer","readOnly":true},"po_number":{"description":"Purchase order number","type":["string","null"]},"restocking_shipment_items":{"description":"A list of items in the shipment. See RestockingShipmentItem.","items":{"$ref":"#/components/schemas/RestockingShipmentItem"},"type":"array"},"status":{"$ref":"#/components/schemas/RestockingShipmentStatus"},"supplier_name":{"description":"Supplier name","type":["string","null"]},"tracking_code":{"description":"Shipment tracking code","type":["string","null"]},"updated_at":{"description":"When the shipment was last updated","format":"date-time","type":"string","readOnly":true},"warehouse_id":{"description":"The ID of the Hive destination warehouse","format":"int64","type":"integer","readOnly":true}},"required":["id","restocking_shipment_items","status","warehouse_id"],"type":"object","examples":[{"id":98765,"barcode":"SHIP-2023-0001","created_at":"2023-09-15T09:00:00Z","delivery_option":"courier","estimated_arrival_date":"2023-09-20","po_number":"PO-2023-001","restocking_shipment_items":[{"id":1,"sku_id":1001,"sku_code":"SKU-001","announced_quantity":50,"arrived_quantity":50,"restocked_quantity":48,"damaged_quantity":0,"missing_quantity":0,"remarks":"All items in good condition","total_cost_in_cents":50000,"unannounced":false}],"status":"arrived","supplier_name":"Acme Supplies","tracking_code":"TRACK-12345","updated_at":"2023-09-20T10:00:00Z","warehouse_id":2}]}},"components/schemas/RestockingShipmentCreate":{"id":"components/schemas/RestockingShipmentCreate","kind":"json-schema","title":"RestockingShipmentCreate","data":{"properties":{"delivery_option":{"$ref":"#/components/schemas/RestockingShipmentDeliveryOption"},"estimated_arrival_date":{"description":"Estimated arrival date","format":"date","type":"string"},"po_number":{"description":"Purchase order number","type":"string"},"restocking_shipment_items":{"description":"A list of items in the shipment. See RestockingShipmentItem.","items":{"properties":{"announced_quantity":{"format":"int32","type":"integer","minimum":1},"remarks":{"type":"string"},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. If both are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"format":"int64","type":"integer"},"total_cost_in_cents":{"format":"int32","type":"integer","minimum":0},"inventory_batch_id":{"description":"The ID of an existing inventory batch to associate with this item","format":"int64","type":"integer"}},"required":["announced_quantity"],"anyOf":[{"required":["sku_id"]},{"required":["sku_code"]}],"type":"object"},"type":"array"},"supplier_name":{"description":"Supplier name","type":"string"},"tracking_code":{"description":"Shipment tracking code","type":"string"},"warehouse_id":{"description":"The ID of the Hive destination warehouse","format":"int64","type":"integer"}},"required":["delivery_option","estimated_arrival_date","restocking_shipment_items","warehouse_id"],"type":"object","examples":[{"delivery_option":"courier","estimated_arrival_date":"2023-09-20","po_number":"PO-2023-001","restocking_shipment_items":[{"sku_id":1001,"sku_code":"SKU-001","announced_quantity":50,"remarks":"All items in good condition","total_cost_in_cents":50000,"inventory_batch_id":12345}],"supplier_name":"Acme Supplies","tracking_code":"TRACK-12345","warehouse_id":2}]}},"components/schemas/RestockingShipmentDeliveryOption":{"id":"components/schemas/RestockingShipmentDeliveryOption","kind":"json-schema","title":"RestockingShipmentDeliveryOption","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery option for the restocking shipment. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"courier: Delivered by courier service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dropoff: Dropped off at designated location"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hive_freight: Delivered using Hive freight service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"postal: Delivered via postal service"},"children":[]}]}]}]}],"enum":["courier","dropoff","hive_freight","postal"],"type":"string"}},"components/schemas/RestockingShipmentItem":{"id":"components/schemas/RestockingShipmentItem","kind":"json-schema","title":"RestockingShipmentItem","data":{"properties":{"announced_quantity":{"description":"Quantity of this item in the shipment","format":"int32","type":"integer","minimum":0},"arrived_quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dock count of this item at receiving (after shipment is received). This is the raw counted quantity and can differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restocked_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not all counted units are put back into sellable stock."},"children":[]}]}]}],"format":"int32","type":"integer","minimum":0},"restocked_quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity put back into sellable stock. This matches the \"restocked\" figure shown in Hive's portal and the sum of the per-batch "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory_batches[].arrived_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"format":"int32","type":"integer","minimum":0},"damaged_quantity":{"description":"Damaged quantity of this item (after shipment is received)","format":"int32","type":"integer","minimum":0},"id":{"description":"Hive's unique identifier","format":"int64","type":"integer"},"inventory_batch":{"description":"The inventory batch announced when creating this item","type":["object","null"],"properties":{"id":{"description":"Hive's unique identifier for the batch","format":"int64","type":"integer"},"lot_number":{"description":"Lot number of the batch","type":["string","null"]},"production_date":{"description":"Production date of the batch","format":"date","type":["string","null"]},"expiry_date":{"description":"Expiry date of the batch","format":"date","type":["string","null"]}},"required":["id"]},"inventory_batches":{"description":"Inventory batches received during restocking (from basket allocations)","deprecated":true,"type":"array","items":{"type":"object","properties":{"id":{"description":"Hive's unique identifier for the inventory batch","format":"int64","type":"integer"},"name":{"description":"Name of the inventory batch","deprecated":true,"type":["string","null"]},"tracking_code":{"description":"Tracking code for the batch","deprecated":true,"type":["string","null"]},"lot_number":{"description":"Lot number of the batch","type":["string","null"]},"production_date":{"description":"Production date of the batch","format":"date","type":["string","null"]},"expiry_date":{"description":"Expiry date of the batch","format":"date","type":["string","null"]},"arrived_quantity":{"description":"Quantity that arrived for this batch","format":"int32","type":"integer"}},"required":["id","arrived_quantity"]}},"missing_quantity":{"description":"Missing quantity of this item (after shipment is received)","format":"int32","type":"integer","minimum":0},"remarks":{"description":"Free text for remarks","type":["string","null"]},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"format":"int64","type":"integer"},"total_cost_in_cents":{"description":"Cost in cents","format":"int32","minimum":0,"type":["integer","null"]},"unannounced":{"description":"Whether this item was auto-created during receiving (not announced by merchant)","type":"boolean"}},"required":["arrived_quantity","restocked_quantity","damaged_quantity","missing_quantity","sku_code","sku_id","unannounced"],"type":"object","examples":[{"id":1,"sku_id":1001,"sku_code":"SKU-001","announced_quantity":50,"arrived_quantity":50,"restocked_quantity":48,"damaged_quantity":0,"missing_quantity":0,"remarks":"All items in good condition","total_cost_in_cents":50000,"unannounced":false,"inventory_batch":{"id":12345,"lot_number":"LOT-2023-001","production_date":"2023-01-15","expiry_date":"2024-01-15"},"inventory_batches":[{"id":12345,"name":"Batch-001","tracking_code":"TRACK-001","lot_number":"LOT-2023-001","production_date":"2023-01-15","expiry_date":"2024-01-15","arrived_quantity":50}]}]}},"components/schemas/RestockingShipmentStatus":{"id":"components/schemas/RestockingShipmentStatus","kind":"json-schema","title":"RestockingShipmentStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restocking shipment status. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"arrived: Hive completed the arrival documentation, checked packing slip, picture of shipment and documents are uploaded"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: the restocking shipment is cancelled by merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created: the restocking shipment is created and not yet shipped"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing: the restocking shipment is getting unpacked and its items are getting restocked into storage boxes and pallets"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"received: the restocking shipment is delivered to the fulfillment center, but its content is not verified yet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"restocked: the restocking shipment is fully processed in the fulfillment center and its items are completely restocked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipped: initial status meaning that restocking shipment is on the way"},"children":[]}]}]}]}],"enum":["arrived","cancelled","created","processing","received","restocked","shipped"],"type":"string","readOnly":true}},"components/schemas/RestockingShipmentUpdate":{"id":"components/schemas/RestockingShipmentUpdate","kind":"json-schema","title":"RestockingShipmentUpdate","data":{"properties":{"delivery_option":{"$ref":"#/components/schemas/RestockingShipmentDeliveryOption"},"estimated_arrival_date":{"description":"Estimated arrival date","format":"date","type":"string"},"po_number":{"description":"Purchase order number","type":"string"},"restocking_shipment_items":{"description":"A list of items in the shipment. See RestockingShipmentItem.","items":{"properties":{"announced_quantity":{"format":"int32","type":"integer","minimum":1},"remarks":{"type":"string"},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"type":"string"},"sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hive SKU identifier - required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}],"format":"int64","type":"integer"},"total_cost_in_cents":{"format":"int32","type":"integer","minimum":0},"inventory_batch_id":{"description":"The ID of an existing inventory batch to associate with this item","format":"int64","type":"integer"}},"required":["announced_quantity"],"anyOf":[{"required":["sku_id"]},{"required":["sku_code"]}],"type":"object"},"type":"array"},"supplier_name":{"description":"Supplier name","type":"string"},"tracking_code":{"description":"Shipment tracking code","type":"string"},"warehouse_id":{"description":"The ID of the Hive destination warehouse","format":"int64","type":"integer"}},"type":"object","examples":[{"delivery_option":"courier","estimated_arrival_date":"2023-09-20","po_number":"PO-2023-001","restocking_shipment_items":[{"sku_id":1001,"sku_code":"SKU-001","announced_quantity":50,"remarks":"All items in good condition","total_cost_in_cents":50000,"inventory_batch_id":12345}],"supplier_name":"Acme Supplies","tracking_code":"TRACK-12345","warehouse_id":2}]}},"components/schemas/Return":{"id":"components/schemas/Return","kind":"json-schema","title":"Return","data":{"properties":{"announced_items":{"description":"List of items announced by the customer (via the Customer Portal). Can be empty if the return is not a Customer Portal return.","items":{"$ref":"#/components/schemas/ReturnAnnouncedItem"},"type":"array"},"carrier":{"description":"Carrier name","type":["string","null"]},"completed_handling_at":{"description":"When the return handling finished","format":"date-time","type":["string","null"]},"created_at":{"description":"When the return was created","format":"date-time","type":"string"},"handled_items":{"description":"List of items that were actually handled in the FC. Can be empty if return items have not been handled in the FC yet.","items":{"$ref":"#/components/schemas/ReturnHandledItem"},"type":"array"},"id":{"description":"Hive's unique identifier","format":"int64","type":"integer"},"order":{"$ref":"#/components/schemas/ReturnOrder"},"photos":{"description":"Photos of the returned items","items":{"$ref":"#/components/schemas/ReturnPhoto"},"type":"array"},"received_at":{"description":"When the return was received","format":"date-time","type":["string","null"]},"return_reason":{"anyOf":[{"$ref":"#/components/schemas/ReturnReason"},{"type":"null"}]},"return_reason_type":{"anyOf":[{"$ref":"#/components/schemas/ReturnReasonType"},{"type":"null"}]},"started_processing_at":{"description":"When processing at the fulfillment center started","format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/ReturnStatus"},"tracking_code":{"description":"Tracking number assigned by the carrier","type":["string","null"]},"tracking_url":{"description":"Carrier website showing tracking information","type":["string","null"]},"updated_at":{"format":"date-time","type":"string"}},"required":["announced_items","created_at","id","order","status","updated_at"],"type":"object","examples":[{"id":5555,"announced_items":[{"id":1,"quantity":1,"sku":{"id":1001,"sku_code":"SKU-001"},"customer_return_reason":"Too small","customer_return_message":"The item did not fit."}],"carrier":"DHL","completed_handling_at":"2023-10-10T15:00:00Z","created_at":"2023-10-08T10:00:00Z","handled_items":[{"id":1,"quantity":1,"sku":{"id":1001,"sku_code":"SKU-001"},"condition":"A","follow_up_action":"restock","photos":[]}],"order":{"id":123456,"merchant_order_id":"ORD-1001","customer_order_number":"CUST-ORD-2023-01"},"photos":[{"id":1,"image_url":"https://cdn.hive.app/returns/1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3","photo_type":"inside"}],"received_at":"2023-10-09T12:00:00Z","return_reason":"customer_return","return_reason_type":"active","started_processing_at":"2023-10-09T13:00:00Z","status":"arrived","tracking_code":"TRACK-RET-123","tracking_url":"https://dhl.com/track/RET-123","updated_at":"2023-10-10T15:00:00Z"}]}},"components/schemas/ReturnAnnouncedItem":{"id":"components/schemas/ReturnAnnouncedItem","kind":"json-schema","title":"ReturnAnnouncedItem","data":{"description":"Announced return item object","properties":{"customer_return_message":{"description":"Reason details provided by the customer","type":"string"},"customer_return_reason":{"description":"Reason provided by the customer","type":"string"},"id":{"description":"Hive's unique identifier","type":"integer"},"quantity":{"description":"Quantity of items announced","type":"integer","minimum":1},"sku":{"$ref":"#/components/schemas/ReturnSku"}},"required":["id","quantity","sku"],"type":"object","examples":[{"id":1,"quantity":1,"sku":{"id":1001,"sku_code":"SKU-001"},"customer_return_reason":"Too small","customer_return_message":"The item did not fit properly."}]}},"components/schemas/ReturnHandledItem":{"id":"components/schemas/ReturnHandledItem","kind":"json-schema","title":"ReturnHandledItem","data":{"description":"Handled return item object","properties":{"condition":{"$ref":"#/components/schemas/ReturnItemCondition"},"follow_up_action":{"$ref":"#/components/schemas/ReturnItemFollowUpAction"},"id":{"description":"Hive's unique identifier","type":"integer"},"inventory_batch_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier in Hive system of the inventory batch (if present) into which returned item is going to be restocked (relevant only when follow_up_action = restock)"},"children":[]}]}]}],"type":["integer","null"]},"photos":{"description":"Photos of the returned item","items":{"$ref":"#/components/schemas/ReturnHandledItemPhoto"},"type":"array"},"quantity":{"description":"The quantity of items returned for the same SKU","type":"integer","minimum":1},"return_item_id":{"description":"Announced return item's unique identifier in Hive system (can be blank, e.g. when the return is not a Customer Portal return)","type":["integer","null"]},"sku":{"$ref":"#/components/schemas/ReturnSku"}},"required":["id","quantity","sku"],"type":"object","examples":[{"id":1,"quantity":1,"sku":{"id":1001,"sku_code":"SKU-001"},"condition":"A","follow_up_action":"restock","inventory_batch_id":12345,"return_item_id":1,"photos":[{"id":1,"image_url":"https://cdn.hive.app/returns/item_1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3"}]}]}},"components/schemas/ReturnHandledItemPhoto":{"id":"components/schemas/ReturnHandledItemPhoto","kind":"json-schema","title":"ReturnHandledItemPhoto","data":{"description":"Photo object for a handled return item","properties":{"id":{"description":"Hive's unique identifier","type":"integer"},"image_url":{"description":"Publicly accessible URL (for 15 minutes)","type":"string"}},"required":["id","image_url"],"type":"object","examples":[{"id":1,"image_url":"https://cdn.hive.app/returns/photos/item_1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3"}]}},"components/schemas/ReturnOrder":{"id":"components/schemas/ReturnOrder","kind":"json-schema","title":"ReturnOrder","data":{"description":"Details of the associated order","properties":{"customer_order_number":{"description":"Customer's order identifier","type":"string"},"id":{"description":"Hive's unique order identifier","type":"integer"},"merchant_order_id":{"description":"Merchant's unique order identifier","type":"string"}},"required":["customer_order_number","id","merchant_order_id"],"type":"object","examples":[{"id":123456,"merchant_order_id":"ORD-1001","customer_order_number":"CUST-ORD-2023-01"}]}},"components/schemas/ReturnPhoto":{"id":"components/schemas/ReturnPhoto","kind":"json-schema","title":"ReturnPhoto","data":{"description":"Photo object for a return","properties":{"id":{"description":"Hive's unique identifier","type":"integer"},"image_url":{"description":"Publicly accessible URL (for 15 minutes)","type":"string"},"photo_type":{"description":"Type of photo. Usual values \"inside\" or \"outside\"","type":"string"}},"required":["id","image_url","photo_type"],"type":"object","examples":[{"id":1,"image_url":"https://cdn.hive.app/returns/1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3","photo_type":"inside"}]}},"components/schemas/ReturnReason":{"id":"components/schemas/ReturnReason","kind":"json-schema","title":"ReturnReason","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for the return. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer_return: Customer initiated return"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customs_documents_missing: Missing customs documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_address: Invalid shipping address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not_picked_up: Package was not picked up by customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other: Other reason not specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected_by_customer: Customer rejected the delivery"},"children":[]}]}]}]}],"enum":["customer_return","customs_documents_missing","invalid_address","not_picked_up","other","rejected_by_customer"],"type":"string"}},"components/schemas/ReturnReasonType":{"id":"components/schemas/ReturnReasonType","kind":"json-schema","title":"ReturnReasonType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of return categorization. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active: Customer return (end-customer actively shipped the return)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"passive: Carrier return (end-customer never received the parcel - shipped back by carrier for reasons like invalid address, not picked up, damages, missing customs documents, etc.)"},"children":[]}]}]}]}],"enum":["active","passive"],"type":"string"}},"components/schemas/ReturnSku":{"id":"components/schemas/ReturnSku","kind":"json-schema","title":"ReturnSku","data":{"description":"SKU details for a returned item","properties":{"id":{"description":"Hive's unique SKU identifier","type":"integer"},"sku_code":{"description":"Merchant's SKU code","type":"string"}},"required":["id","sku_code"],"type":"object","examples":[{"id":1001,"sku_code":"SKU-001"}]}},"components/schemas/ReturnStatus":{"id":"components/schemas/ReturnStatus","kind":"json-schema","title":"ReturnStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the return. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action_required: Waiting for merchant guidance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"arrived: Arrived at fulfillment center"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handling_completed: Return processing completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on_the_way: On the way to fulfillment center"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing: Return processing in progress"},"children":[]}]}]}]}],"enum":["action_required","arrived","handling_completed","on_the_way","processing"],"type":"string","readOnly":true}},"components/schemas/SalesChannel":{"id":"components/schemas/SalesChannel","kind":"json-schema","title":"SalesChannel","data":{"properties":{"active":{"description":"Whether the sales channel is actively syncing data with Hive","type":"boolean"},"created_at":{"description":"When the sales channel was created","format":"date-time","type":"string","readOnly":true},"domain":{"description":"The domain of the sales channel","type":"string"},"id":{"description":"Hive's unique sales channel identifier","format":"int64","type":"integer","readOnly":true},"is_b2b":{"description":"Whether the sales channel is a B2B sales channel (orders imported as B2B by default)","type":"boolean"},"name":{"description":"The name of the sales channel","type":"string"},"reason_for_not_working":{"description":"The reason for the sales channel not working","type":["string","null"]},"type":{"description":"The type of the sales channel","type":"string"},"updated_at":{"description":"When the sales channel was last updated","format":"date-time","type":"string","readOnly":true},"working":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the sales channel integration is working properly. If false, the reason_for_not_working field will be populated."},"children":[]}]}]}],"type":"boolean"}},"required":["active","created_at","domain","id","is_b2b","name","type","updated_at","working"],"type":"object","examples":[{"id":10,"name":"My Shopify Store","domain":"mystore.shopify.com","type":"shopify","active":true,"is_b2b":false,"working":true,"reason_for_not_working":null,"created_at":"2023-01-15T10:00:00Z","updated_at":"2023-10-01T14:30:00Z"}]}},"components/schemas/ShipmentBase":{"id":"components/schemas/ShipmentBase","kind":"json-schema","title":"ShipmentBase","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base Shipment schema used by webhook payloads. Read responses use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which extends this schema with the proof-of-delivery fields."},"children":[]}]}]}],"properties":{"created_at":{"description":"When the shipment was created","format":"date-time","type":"string","readOnly":true},"delivered_at":{"description":"When the shipment was delivered","format":"date-time","type":["string","null"],"readOnly":true},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/ShipmentDeliveryStatus"},{"type":"null"}]},"id":{"description":"The shipment's unique identifier in Hive","format":"int64","type":"integer","readOnly":true},"items":{"description":"Which line items this shipment includes","items":{"$ref":"#/components/schemas/ShipmentItem"},"type":"array"},"merchant_order_id":{"description":"Related order's unique identifier provided by merchant","type":"string"},"order_id":{"description":"Related order's unique identifier in Hive","format":"int64","type":"integer","readOnly":true},"sales_channel_id":{"description":"The ID of the sales channel this shipment belongs to","format":"int64","type":"integer","readOnly":true},"shipment_provider":{"description":"Name of the shipment provider/carrier","type":["string","null"]},"shipped_at":{"description":"When the shipment was shipped","format":"date-time","type":["string","null"],"readOnly":true},"shipping_method":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"tracking_number":{"description":"Tracking number assigned by the shipment provider/carrier","type":["string","null"]},"tracking_url":{"description":"Shipment provider website showing tracking information","type":["string","null"]},"updated_at":{"description":"When the shipment was updated","format":"date-time","type":"string","readOnly":true},"warehouse_id":{"description":"The ID of the warehouse this shipment was fulfilled from","format":"int64","type":["integer","null"],"readOnly":true}},"required":["id","items","order_id","sales_channel_id","status"],"type":"object","examples":[{"id":789012,"order_id":123456,"sales_channel_id":10,"merchant_order_id":"ORD-1001","status":"shipped","delivery_status":"in_transit","shipment_provider":"DHL","shipping_method":"Standard","tracking_number":"1234567890123456","tracking_url":"https://dhl.com/track/1234567890123456","created_at":"2023-10-01T12:00:00Z","shipped_at":"2023-10-02T08:00:00Z","delivered_at":"2023-10-03T14:30:00Z","updated_at":"2023-10-02T08:00:00Z","warehouse_id":42,"items":[{"id":1,"merchant_item_id":"1","quantity":2,"sku":{"id":1001,"sku_code":"SKU-001"},"batches":[{"expiry_date":"2024-12-31","name":"BATCH-001","quantity":2,"tracking_code":"TRACK-001"}],"serial_numbers":[{"serial_number":"SN001"},{"serial_number":"SN002"}]}]}]}},"components/schemas/Shipment":{"id":"components/schemas/Shipment","kind":"json-schema","title":"Shipment","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment schema returned by read endpoints. Extends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShipmentBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof-of-delivery fields, which only read endpoints populate: webhook payloads"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omit them because the presigned POD link expires after ~15 minutes, while"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook delivery retries can span hours. When a webhook arrives, fetch the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment via the shipments endpoint for a fresh link."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ShipmentBase"},{"type":"object","properties":{"proof_of_delivery":{"anyOf":[{"$ref":"#/components/schemas/ShipmentProofOfDelivery"},{"type":"null"}]},"proof_of_delivery_availability":{"$ref":"#/components/schemas/ShipmentProofOfDeliveryAvailability"}}}],"examples":[{"id":789012,"order_id":123456,"sales_channel_id":10,"merchant_order_id":"ORD-1001","status":"shipped","delivery_status":"in_transit","shipment_provider":"DHL","shipping_method":"Standard","tracking_number":"1234567890123456","tracking_url":"https://dhl.com/track/1234567890123456","created_at":"2023-10-01T12:00:00Z","shipped_at":"2023-10-02T08:00:00Z","delivered_at":"2023-10-03T14:30:00Z","updated_at":"2023-10-02T08:00:00Z","warehouse_id":42,"proof_of_delivery":{"url":"https://hive-fulfillment.s3.eu-central-1.amazonaws.com/pod/gls_it/6f9619ff-8b86-d011-b42d-00cf4fc964ff/1234567890123456.pdf?X-Amz-Expires=900&X-Amz-Signature=example","imported_at":"2023-10-03T15:00:00Z","source":"gls_it_ftps"},"proof_of_delivery_availability":"pod_available","items":[{"id":1,"merchant_item_id":"1","quantity":2,"sku":{"id":1001,"sku_code":"SKU-001"},"batches":[{"expiry_date":"2024-12-31","name":"BATCH-001","quantity":2,"tracking_code":"TRACK-001"}],"serial_numbers":[{"serial_number":"SN001"},{"serial_number":"SN002"}]}]}]}},"components/schemas/ShipmentDeliveryStatus":{"id":"components/schemas/ShipmentDeliveryStatus","kind":"json-schema","title":"ShipmentDeliveryStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery status of the shipment. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action_required: Unconventional event (e.g. failed delivery, lost shipment, address issues)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"awaiting_customer_pickup: Package is ready for customer pickup"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered: Successfully delivered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_transit: On the way to carrier hub"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information_transmitted: Information sent to carrier (shipped but no carrier updates yet)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other: Unknown or other delivery status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_for_delivery: Left carrier hub, being delivered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return_initiated: Return process has been initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned_to_sender: Carrier initiated return to sender"},"children":[]}]}]}]}],"enum":["action_required","awaiting_customer_pickup","delivered","in_transit","information_transmitted","other","out_for_delivery","return_initiated","returned_to_sender"],"type":"string","readOnly":true}},"components/schemas/ShipmentProofOfDelivery":{"id":"components/schemas/ShipmentProofOfDelivery","kind":"json-schema","title":"ShipmentProofOfDelivery","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier proof of delivery imported for this shipment. Null when no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POD document was imported — carriers do not guarantee a POD for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every delivery, so absence is not an error (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof_of_delivery_availability)."},"children":[]}]}]}],"properties":{"imported_at":{"description":"When Hive imported the proof of delivery","format":"date-time","type":"string"},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing carrier integration: gls_it_ftps (GLS Italy) or amazon; new integrations may add values"},"children":[]}]}]}],"type":"string"},"url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short-lived presigned link (~15 minutes) to the POD file (PDF or image) — fetch it promptly and never cache it"},"children":[]}]}]}],"format":"uri","type":"string"}},"required":["imported_at","source","url"],"type":"object","readOnly":true}},"components/schemas/ShipmentProofOfDeliveryAvailability":{"id":"components/schemas/ShipmentProofOfDeliveryAvailability","kind":"json-schema","title":"ShipmentProofOfDeliveryAvailability","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a carrier proof of delivery can be expected for this shipment:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pod_available: an imported POD document exists (see proof_of_delivery)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not_a_pod_carrier: the carrier does not provide proofs of delivery — a POD will never appear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not_an_integrated_carrier: the carrier provides PODs, but Hive has no import integration — a POD will not appear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrated_carrier: Hive imports PODs for this carrier; none imported (yet) — a POD may still arrive"},"children":[]}]}]}]}],"enum":["pod_available","not_a_pod_carrier","not_an_integrated_carrier","integrated_carrier"],"type":"string","readOnly":true}},"components/schemas/ShipmentStatus":{"id":"components/schemas/ShipmentStatus","kind":"json-schema","title":"ShipmentStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the shipment. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: Shipment cancelled and will not be fulfilled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_packing: Packing process started"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_picking: Picking process started"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_shipping: Shipping process started"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on_hold: On hold (e.g. future fulfillment, address issues, insufficient inventory)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"packed: Items packed and ready for shipping"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"picked: Items picked and ready for packing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"picking_assigned: Employee assigned to pick items"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipped: Shipping label created and left packing station"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting_for_picking: Initial status, awaiting picking"},"children":[]}]}]}]}],"enum":["cancelled","in_packing","in_picking","in_shipping","on_hold","packed","picked","picking_assigned","shipped","waiting_for_picking"],"type":"string","readOnly":true}},"components/schemas/ShipmentItem":{"id":"components/schemas/ShipmentItem","kind":"json-schema","title":"ShipmentItem","data":{"properties":{"batches":{"description":"Which batches were sent for this line item","items":{"$ref":"#/components/schemas/ShipmentItemBatch"},"type":"array"},"id":{"description":"The shipment item's unique identifier in Hive","format":"int64","type":"integer"},"merchant_item_id":{"description":"The order line item identifier as provided by the merchant. Will be null for items added later (e.g. via add-on rules).","type":["string","null"]},"quantity":{"description":"Number of SKUs in this line item","format":"int32","type":"integer"},"serial_numbers":{"description":"Which serial numbers were sent for this line item","items":{"$ref":"#/components/schemas/ShipmentItemSerialNumber"},"type":"array"},"sku":{"$ref":"#/components/schemas/ShipmentItemSku"}},"required":["id","quantity","sku"],"type":"object","examples":[{"id":1,"merchant_item_id":"1","quantity":2,"sku":{"id":1001,"sku_code":"SKU-001"},"batches":[{"expiry_date":"2024-12-31","name":"BATCH-001","quantity":2,"tracking_code":"TRACK-001"}],"serial_numbers":[{"serial_number":"SN001"},{"serial_number":"SN002"}]}]}},"components/schemas/ShipmentItemBatch":{"id":"components/schemas/ShipmentItemBatch","kind":"json-schema","title":"ShipmentItemBatch","data":{"properties":{"expiry_date":{"description":"Expiration date of the batch","format":"date","type":"string"},"name":{"description":"Name of the batch","type":"string"},"quantity":{"description":"Number of items taken from this batch","format":"int32","type":"integer"},"tracking_code":{"description":"Tracking code of the batch","type":"string"}},"required":["expiry_date","name","quantity","tracking_code"],"type":"object","examples":[{"expiry_date":"2024-12-31","name":"BATCH-001","quantity":2,"tracking_code":"TRACK-001"}]}},"components/schemas/ShipmentItemSerialNumber":{"id":"components/schemas/ShipmentItemSerialNumber","kind":"json-schema","title":"ShipmentItemSerialNumber","data":{"properties":{"serial_number":{"description":"The serial number","type":"string"}},"required":["serial_number"],"type":"object","examples":[{"serial_number":"SN001"}]}},"components/schemas/ShipmentItemSku":{"id":"components/schemas/ShipmentItemSku","kind":"json-schema","title":"ShipmentItemSku","data":{"properties":{"id":{"description":"Hive unique identifier for the SKU","format":"int64","type":"integer"},"sku_code":{"description":"SKU identifier as provided by the merchant","type":"string"}},"required":["id","sku_code"],"type":"object","examples":[{"id":1001,"sku_code":"SKU-001"}]}},"components/schemas/Sku":{"id":"components/schemas/Sku","kind":"json-schema","title":"Sku","data":{"properties":{"barcode":{"description":"Barcode of the SKU","type":["string","null"],"minLength":1},"batch_tracking_enabled":{"description":"Whether batch tracking of this SKU is enabled","type":"boolean"},"cost_in_cents":{"description":"Cost in cents (currency of the shop is implied)","type":["integer","null"],"minimum":0},"country_code_of_origin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code of country of origin"},"children":[]}]}]}],"type":["string","null"],"pattern":"^[A-Z]{2}$"},"created_at":{"description":"When this SKU was created","format":"date-time","type":"string","readOnly":true},"updated_at":{"description":"When this SKU was last updated","format":"date-time","type":"string","readOnly":true},"dangerous_good":{"description":"Sku is a dangerous good","type":"boolean"},"fulfilled_by":{"$ref":"#/components/schemas/SkuFulfilledBy"},"h_codes":{"description":"Hazardous good H Codes","items":{"type":"string"},"type":"array"},"buffer_per_sales_channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory-level buffer (in units) held back from the stock levels pushed to each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sales channel configured. Each entry reflects one sales channel: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buffer_setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the raw override (0 means \"no override, use the sales channel default\"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buffer_effective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the value actually applied after falling back to the sales"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel default when the override is 0."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/SkuBufferPerSalesChannel"}},"has_blocking_issues":{"description":"Whether this SKU has pending blocking issues that prevent fulfillment","type":"boolean"},"hazardous_good":{"description":"SKU is a hazardous good","type":"boolean"},"hs_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The general "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Harmonized_System"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Harmonized System (HS) code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the SKU"},"children":[]}]}]}],"type":["string","null"]},"id":{"description":"Hive unique identifier for this SKU","format":"int64","type":"integer","readOnly":true},"image_url":{"description":"Publicly accessible URL of an image for this SKU","type":["string","null"]},"inventory":{"$ref":"#/components/schemas/SkuInventory"},"inventory_batches":{"description":"Current inventory per batch","items":{"$ref":"#/components/schemas/SkuInventoryBatch"},"type":"array"},"inventory_per_warehouse":{"description":"Current inventory per warehouse","items":{"$ref":"#/components/schemas/SkuInventoryPerWarehouse"},"type":"array"},"effective_inventory_batch_settings":{"description":"Effective inventory batch settings for this SKU (SKU-specific override or merchant default)","anyOf":[{"$ref":"#/components/schemas/InventoryBatchSettings"},{"type":"null"}]},"name":{"description":"Name of this SKU","type":"string"},"sku_code":{"description":"SKU code - visible in the UI","type":"string"},"status":{"$ref":"#/components/schemas/SkuStatus"},"un_numbers":{"description":"Dangerous good UN Numbers","items":{"type":"string"},"type":"array"},"weight_in_kg":{"description":"Weight of SKU in kilograms","anyOf":[{"type":"number"},{"type":"null"}],"minimum":0}},"required":["batch_tracking_enabled","buffer_per_sales_channel","created_at","dangerous_good","effective_inventory_batch_settings","fulfilled_by","h_codes","hazardous_good","id","inventory","inventory_batches","inventory_per_warehouse","name","sku_code","status","un_numbers","updated_at","weight_in_kg"],"type":"object","examples":[{"id":1001,"name":"T-Shirt Black M","sku_code":"SKU-001","barcode":"1234567890123","batch_tracking_enabled":false,"buffer_per_sales_channel":[{"sales_channel_id":12,"shop_sku_id":5501,"sku_code":"SHOPIFY-SKU-001","buffer_setting":5,"buffer_effective":5},{"sales_channel_id":23,"shop_sku_id":5502,"sku_code":"WOO-SKU-001","buffer_setting":0,"buffer_effective":10}],"cost_in_cents":800,"country_code_of_origin":"DE","created_at":"2023-09-01T08:00:00Z","updated_at":"2023-10-01T14:30:00Z","dangerous_good":false,"fulfilled_by":"hive","h_codes":[],"hazardous_good":false,"hs_code":"610910","image_url":"https://cdn.hive.app/skus/sku-001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3","inventory":{"available":90,"reserved":10,"stocked":100,"outbound":4,"blocked":0,"damaged":0,"missing":0,"in_restocking":0,"returned":0,"thrown_away":0,"sendback":0},"inventory_batches":[],"inventory_per_warehouse":[{"warehouse_id":2,"available":45,"reserved":5,"stocked":50,"outbound":2,"blocked":0,"damaged":0,"missing":0,"in_restocking":0,"returned":0,"thrown_away":0,"sendback":0}],"status":"active","un_numbers":[],"weight_in_kg":0.2,"effective_inventory_batch_settings":{"id":501,"batch_priority":"first_expired_first_out","b2c_shelf_life_in_weeks":12,"b2b_shelf_life_in_weeks":24,"ito_shelf_life_in_weeks":8,"kit_shelf_life_in_weeks":6,"is_merchant_default":true,"sku_id":null}}]}},"components/schemas/SkuCreate":{"id":"components/schemas/SkuCreate","kind":"json-schema","title":"SkuCreate","data":{"properties":{"barcode":{"description":"The SKU barcode","type":["string","null"],"minLength":1},"batch_tracking_enabled":{"description":"Enables inventory tracking per batch (defaults to false if omitted)","type":"boolean"},"cost_in_cents":{"description":"The cost (not price) of this SKU","type":["integer","null"],"minimum":0},"country_code_of_origin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code of country of origin"},"children":[]}]}]}],"type":["string","null"],"pattern":"^[A-Z]{2}$"},"hs_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Harmonized_System"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Harmonized System"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code"},"children":[]}]}]}],"type":["string","null"]},"image_url":{"description":"Image of the product, must be publicly accessible.","type":["string","null"]},"name":{"description":"A human-readable name or title","type":"string","minLength":1},"sku_code":{"description":"An ID that uniquely identifies this SKU","type":"string","minLength":1},"weight_in_kg":{"description":"Weight in kilograms","anyOf":[{"type":"number"},{"type":"null"}],"minimum":0}},"required":["name","sku_code"],"type":"object","examples":[{"name":"T-Shirt Black M","sku_code":"SKU-001","barcode":"1234567890123","batch_tracking_enabled":false,"cost_in_cents":800,"country_code_of_origin":"DE","hs_code":"610910","image_url":"https://cdn.hive.app/skus/sku-001.jpg","weight_in_kg":0.2}]}},"components/schemas/SkuInventory":{"id":"components/schemas/SkuInventory","kind":"json-schema","title":"SkuInventory","data":{"properties":{"available":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity available for sale ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer"},"reserved":{"description":"Quantity reserved/committed for orders","type":"integer","minimum":0},"stocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the warehouse ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer","minimum":0},"outbound":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity on shipments that have been picked from storage but not yet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handed to the carrier (shipment statuses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_picking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"picked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_packing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). These units have already been removed from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and are disjoint from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so they are not subtracted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again. Shipments in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not counted."},"children":[]}]}]}],"type":"integer","minimum":0},"blocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in storage boxes flagged as blocked (e.g. pending investigation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"financing hold, customer block). Blocked stock is included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be picked until the block is resolved."},"children":[]}]}]}],"type":"integer","minimum":0},"damaged":{"description":"Quantity marked as damaged","type":"integer","minimum":0},"missing":{"description":"Quantity marked as missing","type":"integer","minimum":0},"in_restocking":{"description":"Quantity currently being restocked","type":"integer","minimum":0},"returned":{"description":"Quantity returned","type":"integer","minimum":0},"thrown_away":{"description":"Quantity disposed of","type":"integer","minimum":0},"sendback":{"description":"Quantity marked for sendback to merchant","type":"integer","minimum":0}},"required":["available","reserved","stocked","outbound","blocked","damaged","missing","in_restocking","returned","thrown_away","sendback"],"type":"object","examples":[{"available":90,"reserved":10,"stocked":100,"outbound":4,"blocked":0,"damaged":2,"missing":0,"in_restocking":5,"returned":3,"thrown_away":0,"sendback":1}]}},"components/schemas/SkuInventoryBatch":{"id":"components/schemas/SkuInventoryBatch","kind":"json-schema","title":"SkuInventoryBatch","data":{"properties":{"blocked":{"description":"Whether this batch has pending blocking issues that prevent fulfillment","type":"boolean"},"expiry_date":{"description":"Expiration date of the batch (ISO8601 date, read-only)","type":["string","null"],"format":"date"},"id":{"description":"Hive unique ID for the batch (read-only)","type":"integer"},"lot_number":{"description":"Lot number for the batch (read-only)","type":["string","null"]},"name":{"description":"Name of the batch","type":"string","deprecated":true},"production_date":{"description":"Production date of the batch (ISO8601 date, read-only)","type":["string","null"],"format":"date"},"status":{"description":"Status of the batch (active or archived)","type":"string","enum":["active","archived"]},"stocked_quantities":{"description":"Inventory per warehouse for this batch (see SkuInventoryBatchQuantityPerWarehouse) (read-only)","items":{"$ref":"#/components/schemas/SkuInventoryBatchQuantityPerWarehouse"},"type":"array"},"tracking_code":{"description":"Tracking code","type":["string","null"],"deprecated":true}},"required":["expiry_date","id","lot_number","name","production_date","stocked_quantities","tracking_code"],"type":"object","examples":[{"blocked":false,"expiry_date":"2024-12-31","id":1,"lot_number":"LOT-001","name":"Batch-001","production_date":"2024-01-15","status":"active","stocked_quantities":[{"warehouse_id":2,"stocked":50}],"tracking_code":"BATCH-TRACK-001"}]}},"components/schemas/SkuInventoryBatchQuantityPerWarehouse":{"id":"components/schemas/SkuInventoryBatchQuantityPerWarehouse","kind":"json-schema","title":"SkuInventoryBatchQuantityPerWarehouse","data":{"properties":{"stocked":{"description":"Quantity in the warehouse for this batch in this warehouse","type":"integer","minimum":0},"warehouse_id":{"description":"Hive's unique warehouse ID","type":"integer"}},"required":["stocked","warehouse_id"],"type":"object","examples":[{"warehouse_id":2,"stocked":50}]}},"components/schemas/SkuInventoryPerWarehouse":{"id":"components/schemas/SkuInventoryPerWarehouse","kind":"json-schema","title":"SkuInventoryPerWarehouse","data":{"properties":{"available":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity available for sale ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer"},"reserved":{"description":"Quantity reserved/committed for orders","type":"integer","minimum":0},"stocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the warehouse ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer","minimum":0},"outbound":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity at this warehouse on shipments that have been picked from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"storage but not yet handed to the carrier (shipment statuses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_picking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"picked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_packing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Already removed from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and disjoint from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so not subtracted from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again. Shipments in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not counted."},"children":[]}]}]}],"type":"integer","minimum":0},"blocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in storage boxes flagged as blocked at this warehouse. Included in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but cannot be picked until the block is resolved."},"children":[]}]}]}],"type":"integer","minimum":0},"warehouse_id":{"description":"Hive's unique warehouse ID","type":"integer"},"damaged":{"description":"Quantity marked as damaged","type":"integer","minimum":0},"missing":{"description":"Quantity marked as missing","type":"integer","minimum":0},"in_restocking":{"description":"Quantity currently being restocked","type":"integer","minimum":0},"returned":{"description":"Quantity returned","type":"integer","minimum":0},"thrown_away":{"description":"Quantity disposed of","type":"integer","minimum":0},"sendback":{"description":"Quantity marked for sendback to merchant","type":"integer","minimum":0}},"required":["available","reserved","stocked","outbound","blocked","warehouse_id","damaged","missing","in_restocking","returned","thrown_away","sendback"],"type":"object","examples":[{"warehouse_id":2,"available":45,"reserved":5,"stocked":50,"outbound":2,"blocked":0,"damaged":1,"missing":0,"in_restocking":2,"returned":1,"thrown_away":0,"sendback":0}]}},"components/schemas/SkuBufferPerSalesChannel":{"id":"components/schemas/SkuBufferPerSalesChannel","kind":"json-schema","title":"SkuBufferPerSalesChannel","data":{"type":"object","properties":{"sales_channel_id":{"description":"ID of the sales channel this buffer applies to","format":"int64","type":"integer"},"shop_sku_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopSku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" record this entry corresponds to. Each entry maps to exactly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopSku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; sales channels that have no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopSku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this SKU are not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"included in the list, and a sales channel with multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopSku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s for this SKU"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"produces multiple entries (same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_channel_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", different "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop_sku_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"int64","type":"integer"},"sku_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SKU code as it appears on this sales channel (the per-channel "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopSku"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier). May differ from the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (which is the internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code)."},"children":[]}]}]}],"type":"string"},"buffer_setting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-sales-channel SKU override. A value of 0 means no override is set — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sales channel default is used instead (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buffer_effective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Negative values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are allowed (e.g. to keep the product visible while a restocking is inbound)."},"children":[]}]}]}],"type":"integer"},"buffer_effective":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The buffer actually applied to stock levels pushed to this sales channel: equal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buffer_setting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when non-zero, otherwise the sales channel's default buffer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be negative (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buffer_setting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"integer"}},"required":["sales_channel_id","shop_sku_id","sku_code","buffer_setting","buffer_effective"],"examples":[{"sales_channel_id":12,"shop_sku_id":5501,"sku_code":"SHOPIFY-SKU-001","buffer_setting":100,"buffer_effective":100},{"sales_channel_id":12,"shop_sku_id":5502,"sku_code":"SHOPIFY-SKU-001-V2","buffer_setting":0,"buffer_effective":20}]}},"components/schemas/SkuPatch":{"id":"components/schemas/SkuPatch","kind":"json-schema","title":"SkuPatch","data":{"properties":{"barcode":{"description":"The SKU barcode","type":["string","null"],"minLength":1},"batch_tracking_enabled":{"description":"Enables inventory tracking per batch (defaults to false if omitted)","type":"boolean"},"cost_in_cents":{"description":"The cost (not price) of this SKU","type":["integer","null"],"minimum":0},"country_code_of_origin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code of country of origin"},"children":[]}]}]}],"type":["string","null"],"pattern":"^[A-Z]{2}$"},"hs_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Harmonized_System"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Harmonized System"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code"},"children":[]}]}]}],"type":["string","null"]},"image_url":{"description":"Image of the product, must be publicly accessible.","type":["string","null"]},"name":{"description":"A human-readable name or title","type":"string","minLength":1},"sku_code":{"description":"An ID that uniquely identifies this SKU","type":"string","minLength":1},"weight_in_kg":{"description":"Weight in kilograms","anyOf":[{"type":"number"},{"type":"null"}],"minimum":0}},"type":"object","examples":[{"name":"T-Shirt Black M","sku_code":"SKU-001","barcode":"1234567890123","batch_tracking_enabled":false,"cost_in_cents":800,"country_code_of_origin":"DE","hs_code":"610910","image_url":"https://cdn.hive.app/skus/sku-001.jpg","weight_in_kg":0.2}]}},"components/schemas/Warehouse":{"id":"components/schemas/Warehouse","kind":"json-schema","title":"Warehouse","data":{"properties":{"city":{"description":"City where the warehouse is located","readOnly":true,"type":"string"},"country":{"allOf":[{"$ref":"#/components/schemas/CountryCode"}],"readOnly":true},"created_at":{"description":"When the warehouse was created","format":"date-time","type":"string","readOnly":true},"id":{"description":"Hive unique ID","format":"int64","readOnly":true,"type":"integer"},"name":{"description":"Name of the warehouse","readOnly":true,"type":"string"},"updated_at":{"description":"When the warehouse was last updated","format":"date-time","type":"string","readOnly":true}},"required":["id","name","created_at","updated_at"],"type":"object","examples":[{"id":2,"name":"BER1","city":"Berlin","country":"DE","created_at":"2023-01-15T10:00:00Z","updated_at":"2023-10-01T14:30:00Z"}]}},"components/schemas/ReturnRules":{"id":"components/schemas/ReturnRules","kind":"json-schema","title":"ReturnRules","data":{"description":"The merchant's return rules, including the send-back address and the\nfollow-up action configured for each return condition.\n","type":"object","properties":{"send_back_address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address that items are sent back to when the follow-up action is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"send_back"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no send-back address is configured."},"children":[]}]}]}],"type":["object","null"],"properties":{"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"company":{"type":["string","null"]},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"province_or_state_code":{"type":["string","null"]},"country_code":{"type":["string","null"]}}},"default_rules":{"description":"Default follow-up action per return condition.","type":"object","properties":{"A":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"},"B":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"},"C":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"}},"required":["A","B","C"]},"sku_rules":{"description":"SKU-specific follow-up actions that override the defaults.","type":"array","items":{"type":"object","properties":{"sku":{"type":"object","properties":{"id":{"format":"int64","type":"integer"},"sku_code":{"type":"string"}},"required":["id","sku_code"]},"A":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"},"B":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"},"C":{"$ref":"#/components/schemas/ReturnRuleFollowUpAction"}},"required":["sku"]}}},"required":["send_back_address","default_rules","sku_rules"]}},"components/schemas/ReturnRuleFollowUpAction":{"id":"components/schemas/ReturnRuleFollowUpAction","kind":"json-schema","title":"ReturnRuleFollowUpAction","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Follow-up action configured for a return condition, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rule is set for that condition."},"children":[]}]}]}],"type":["string","null"],"enum":["dispose","restock","send_back",null]}},"components/schemas/ReturnItemCondition":{"id":"components/schemas/ReturnItemCondition","kind":"json-schema","title":"ReturnItemCondition","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition of the returned item. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: Unused and in original packaging"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B: Unused with missing/damaged packaging"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C: Product is used or damaged"},"children":[]}]}]}]}],"enum":["A","B","C"],"type":"string"}},"components/schemas/ReturnItemFollowUpAction":{"id":"components/schemas/ReturnItemFollowUpAction","kind":"json-schema","title":"ReturnItemFollowUpAction","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action to be performed on the returned item. Those actions are pre-selected based on return rules (Hive account manager inserts return rules into the system after negotiation with a merchant)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispose: Dispose of the item"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"restock: Restock the item for sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send_back: Send the item back to the merchant"},"children":[]}]}]}]}],"enum":["dispose","restock","send_back"],"type":"string"}},"components/schemas/SkuFulfilledBy":{"id":"components/schemas/SkuFulfilledBy","kind":"json-schema","title":"SkuFulfilledBy","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who is fulfilling this SKU. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hive: Fulfilled by Hive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new: Default value for newly imported SKUs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other: Fulfilled by another party"},"children":[]}]}]}]}],"enum":["hive","new","other"],"type":"string"}},"components/schemas/SkuStatus":{"id":"components/schemas/SkuStatus","kind":"json-schema","title":"SkuStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of this SKU. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active: SKU is active and available for orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted: SKU is deleted and no longer available"},"children":[]}]}]}]}],"enum":["active","deleted"],"type":"string"}},"components/schemas/InventoryTransferOrderStatus":{"id":"components/schemas/InventoryTransferOrderStatus","kind":"json-schema","title":"InventoryTransferOrderStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the inventory transfer order. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: Initial status when the transfer order is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created: The transfer order has been created and is ready for processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing: The transfer order is currently being processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The transfer order has been successfully completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: The transfer order has been cancelled"},"children":[]}]}]}]}],"enum":["pending","created","processing","completed","cancelled"],"type":"string","readOnly":true}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" country code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: DE, US, FR, NL"},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$","examples":["DE"]}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_4217"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: EUR, USD, GBP, JPY"},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{3}$","examples":["EUR"]}},"components/schemas/WebhookOrder":{"id":"components/schemas/WebhookOrder","kind":"json-schema","title":"WebhookOrder","data":{"type":"object","properties":{"event_type":{"description":"The type of webhook event","type":"string","enum":["order.status_updated"]},"event_id":{"description":"Unique identifier for this webhook event","type":"string","format":"uuid"},"timestamp":{"description":"When the event occurred","type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/OrderBase"}},"required":["event_type","event_id","timestamp","data"],"examples":[{"event_type":"order.status_updated","event_id":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2023-10-01T12:00:00Z","data":{"id":123456,"merchant_order_id":"ORD-1001","sales_channel_id":10,"fulfillment_status":"shipped","financial_status":"paid","created_at":"2023-10-01T12:00:00Z","currency":"EUR","total_price_in_cents":3000,"total_net_refunds_in_cents":0,"total_net_revenue_in_cents":2430,"total_tax_in_cents":570,"total_tax_refunds_in_cents":0,"carrier_preference":"DHL","updated_at":"2023-10-01T14:30:00Z","items":[{"merchant_item_id":"1","quantity":2,"sku_code":"SKU-001","sku_id":1001}],"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"}}}]}},"components/schemas/WebhookShipment":{"id":"components/schemas/WebhookShipment","kind":"json-schema","title":"WebhookShipment","data":{"type":"object","properties":{"event_type":{"description":"The type of webhook event","type":"string","enum":["shipment.status_updated","shipment.delivery_status_updated"]},"event_id":{"description":"Unique identifier for this webhook event","type":"string","format":"uuid"},"timestamp":{"description":"When the event occurred","type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/ShipmentBase"}},"required":["event_type","event_id","timestamp","data"],"examples":[{"event_type":"shipment.status_updated","event_id":"123e4567-e89b-12d3-a456-426614174001","timestamp":"2023-10-01T15:00:00Z","data":{"id":789012,"order_id":123456,"sales_channel_id":10,"status":"shipped","items":[{"id":1,"merchant_item_id":"1","quantity":2,"sku":{"id":1001,"sku_code":"SKU-001"},"batches":[{"expiry_date":"2024-12-31","name":"BATCH-001","quantity":2,"tracking_code":"TRACK-001"}],"serial_numbers":[{"serial_number":"SN001"},{"serial_number":"SN002"}]}]}}]}},"components/schemas/WebhookRestockingShipment":{"id":"components/schemas/WebhookRestockingShipment","kind":"json-schema","title":"WebhookRestockingShipment","data":{"type":"object","properties":{"event_type":{"description":"The type of webhook event","type":"string","enum":["restocking_shipment.status_updated"]},"event_id":{"description":"Unique identifier for this webhook event","type":"string","format":"uuid"},"timestamp":{"description":"When the event occurred","type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/RestockingShipment"}},"required":["event_type","event_id","timestamp","data"],"examples":[{"event_type":"restocking_shipment.status_updated","event_id":"123e4567-e89b-12d3-a456-426614174003","timestamp":"2023-10-01T16:00:00Z","data":{"id":98765,"status":"arrived","warehouse_id":2,"restocking_shipment_items":[{"id":1,"sku_id":1001,"sku_code":"SKU-001","announced_quantity":50,"arrived_quantity":50,"restocked_quantity":48,"damaged_quantity":0,"missing_quantity":0,"unannounced":false,"inventory_batch":null}]}}]}},"components/schemas/WebhookReturn":{"id":"components/schemas/WebhookReturn","kind":"json-schema","title":"WebhookReturn","data":{"type":"object","properties":{"event_type":{"description":"The type of webhook event","type":"string","enum":["return.status_updated"]},"event_id":{"description":"Unique identifier for this webhook event","type":"string","format":"uuid"},"timestamp":{"description":"When the event occurred","type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/Return"}},"required":["event_type","event_id","timestamp","data"],"examples":[{"event_type":"return.status_updated","event_id":"123e4567-e89b-12d3-a456-426614174002","timestamp":"2023-10-01T18:00:00Z","data":{"id":5555,"status":"arrived","created_at":"2023-10-01T18:00:00Z","updated_at":"2023-10-01T18:00:00Z","announced_items":[{"id":1,"quantity":1,"sku":{"id":1001,"sku_code":"SKU-001"}}],"order":{"id":123456,"merchant_order_id":"ORD-1001","customer_order_number":"CUST-ORD-2023-01"}}}]}},"components/schemas/WebhookInventoryTransferOrder":{"id":"components/schemas/WebhookInventoryTransferOrder","kind":"json-schema","title":"WebhookInventoryTransferOrder","data":{"type":"object","properties":{"event_type":{"description":"The type of webhook event","type":"string","enum":["inventory_transfer_order.status_updated"]},"event_id":{"description":"Unique identifier for this webhook event","type":"string","format":"uuid"},"timestamp":{"description":"When the event occurred","type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/InventoryTransferOrder"}},"required":["event_type","event_id","timestamp","data"],"examples":[{"event_type":"inventory_transfer_order.status_updated","event_id":"123e4567-e89b-12d3-a456-426614174004","timestamp":"2023-10-01T19:00:00Z","data":{"id":123456,"status":"completed","created_at":"2023-10-01T19:00:00Z","completed_at":"2023-10-01T20:00:00Z","origin_id":4,"destination_id":2,"updated_at":"2023-10-01T20:00:00Z","order":{"id":1195780,"status":"processing"},"order_notes":"","documents":[],"restocking_shipments":[],"shipments":[],"items":[{"id":427,"quantity":50,"sku_id":1001,"sku_code":"SKU-001","inventory_batch":{"id":100,"name":"Batch-A","expiry_date":"2025-12-31"},"inventory_batches":[{"id":100,"name":"Batch-A","expiry_date":"2025-12-31","quantity":30},{"id":101,"name":"Batch-B","expiry_date":"2026-03-15","quantity":20}]}]}}]}},"schema_23":{"kind":"json-schema","data":{"default":20,"maximum":100,"minimum":1,"type":"integer"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"format":"date-time","type":"string"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"items":{"format":"int64","type":"integer"},"type":"array"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"items":{"type":"string"},"type":"array"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InventoryTransaction"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryBatchSettings"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"batch_priority":{"type":"string","enum":["first_expired_first_out","first_produced_first_out"]},"b2c_shelf_life_in_weeks":{"type":["integer","null"]},"b2b_shelf_life_in_weeks":{"type":["integer","null"]},"ito_shelf_life_in_weeks":{"type":["integer","null"]},"kit_shelf_life_in_weeks":{"type":["integer","null"]}}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"format":"int64","type":"integer"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryTransferOrder"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","examples":["a1b2c3d4e5f6..."]},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","properties":{"X-Rate-Limit-Used":{"type":"integer","description":"The number of requests used in the current minute.","examples":{"default":{"value":"10"}}},"X-Rate-Limit-Max":{"type":"integer","description":"The maximum number of requests allowed per minute (100).","examples":{"default":{"value":"100"}}}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RestockingShipment"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Return"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"items":{"type":"string","minLength":1},"type":"array"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Sku"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SalesChannel"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Warehouse"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"id":"schema_45"}},"exampleStore":{"paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1inventory~1transactions/get/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory~1transactions/get/responses/401/content/application~1json/examples/default"},"paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory~1transactions/get/responses/403/content/application~1json/examples/default"},"paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory~1transactions/get/responses/429/content/application~1json/examples/default"},"paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"},"paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"},"paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings~1default/get/responses/401/content/application~1json/examples/default"},"paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings~1default/get/responses/404/content/application~1json/examples/default"},"paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings~1default/get/responses/429/content/application~1json/examples/default"},"paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1inventory_batch_settings~1default/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings~1default/patch/responses/401/content/application~1json/examples/default"},"paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1inventory_batch_settings~1default/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_batch_settings~1default/patch/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/get/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/put/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batch_settings/delete/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches/post/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1block/post/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{sku_id}~1inventory_batches~1{id}~1unblock/post/responses/429/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/get/responses/401/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/get/responses/403/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/get/responses/429/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1inventory_transfer_orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/post/responses/401/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/post/responses/403/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1inventory_transfer_orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders/post/responses/429/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/get/responses/403/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/get/responses/429/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/401/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/403/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/404/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}/patch/responses/429/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1inventory_transfer_orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"},"paths/~1orders/get/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1orders/get/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1orders/get/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1orders/get/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1orders/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders/get/responses/401/content/application~1json/examples/default"},"paths/~1orders/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders/get/responses/403/content/application~1json/examples/default"},"paths/~1orders/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders/get/responses/429/content/application~1json/examples/default"},"paths/~1orders/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1orders/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1orders/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1orders/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1orders/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders/post/responses/401/content/application~1json/examples/default"},"paths/~1orders/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders/post/responses/403/content/application~1json/examples/default"},"paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict":{"value":{"success":false,"errors":{"merchant_order_id":["a record with this data already exists"]}},"key":"validation_conflict","summary":"Validation conflict (legacy format)","id":"paths/~1orders/post/responses/409/content/application~1json/examples/validation_conflict"},"paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict":{"value":{"success":false,"title":"Conflict","status":409,"errors":["A record with this data already exists"]},"key":"general_conflict","summary":"General conflict","id":"paths/~1orders/post/responses/409/content/application~1json/examples/general_conflict"},"paths/~1orders/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1orders/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1orders/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1orders/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1orders/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders/post/responses/429/content/application~1json/examples/default"},"paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/get/responses/403/content/application~1json/examples/default"},"paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/get/responses/429/content/application~1json/examples/default"},"paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference":{"value":{"carrier_preference":"PostNL"},"key":"updateCarrierPreference","summary":"Update order carrier preference","id":"paths/~1orders~1{id}/patch/requestBody/content/application~1json/examples/updateCarrierPreference"},"paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated":{"value":{"id":123456,"items":[{"merchant_item_id":"1","price_per_unit_in_cents":1500,"quantity":2,"sku_code":"SKU-001","sku_id":1001}],"merchant_order_id":"ORD-1001","sales_channel_id":10,"shipping_address":{"city":"Berlin","country_code":"DE","first_name":"Anna","line1":"Alexanderplatz 1","postal_code":"10178"},"fulfillment_status":"shipped","financial_status":"paid","created_at":"2023-10-01T12:00:00Z","currency":"EUR","payment_method":"credit_card","tags":["priority","gift"],"total_price_in_cents":3000,"total_tax_in_cents":570,"total_net_revenue_in_cents":2430,"total_net_refunds_in_cents":0,"total_tax_refunds_in_cents":0,"custom_metadata":{"gift_message":"Happy Birthday!"},"customer_order_number":"CUST-ORD-2023-01","carrier_preference":"PostNL","updated_at":"2023-10-01T15:30:00Z"},"key":"updated","summary":"Order updated successfully","id":"paths/~1orders~1{id}/patch/responses/200/content/application~1json/examples/updated"},"paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1orders~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/patch/responses/401/content/application~1json/examples/default"},"paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/patch/responses/403/content/application~1json/examples/default"},"paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/patch/responses/404/content/application~1json/examples/default"},"paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1orders~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}/patch/responses/429/content/application~1json/examples/default"},"paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"},"paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"},"paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"},"paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1orders~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/get/responses/401/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/get/responses/403/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/get/responses/404/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/get/responses/429/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1orders~1by_merchant_order_id/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/patch/responses/401/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/patch/responses/403/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/patch/responses/404/content/application~1json/examples/default"},"paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1orders~1by_merchant_order_id/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1orders~1by_merchant_order_id/patch/responses/429/content/application~1json/examples/default"},"paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/get/responses/401/content/application~1json/examples/default"},"paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/get/responses/403/content/application~1json/examples/default"},"paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/get/responses/429/content/application~1json/examples/default"},"paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1restocking_shipments/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/post/responses/401/content/application~1json/examples/default"},"paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/post/responses/403/content/application~1json/examples/default"},"paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1restocking_shipments/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments/post/responses/429/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/get/responses/403/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/get/responses/429/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1restocking_shipments~1{id}/put/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/put/responses/401/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/put/responses/403/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/put/responses/404/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1restocking_shipments~1{id}/put/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}/put/responses/429/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/401/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/403/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/404/content/application~1json/examples/default"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1restocking_shipments~1{id}~1cancel/put/responses/429/content/application~1json/examples/default"},"paths/~1returns/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1returns/get/responses/401/content/application~1json/examples/default"},"paths/~1returns/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1returns/get/responses/403/content/application~1json/examples/default"},"paths/~1returns/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1returns/get/responses/429/content/application~1json/examples/default"},"paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1returns~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1returns~1{id}/get/responses/403/content/application~1json/examples/default"},"paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1returns~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1returns~1{id}/get/responses/429/content/application~1json/examples/default"},"paths/~1return_rules/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1return_rules/get/responses/401/content/application~1json/examples/default"},"paths/~1return_rules/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1return_rules/get/responses/403/content/application~1json/examples/default"},"paths/~1return_rules/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1return_rules/get/responses/429/content/application~1json/examples/default"},"paths/~1skus/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus/get/responses/401/content/application~1json/examples/default"},"paths/~1skus/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus/get/responses/403/content/application~1json/examples/default"},"paths/~1skus/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus/get/responses/429/content/application~1json/examples/default"},"paths/~1skus/post/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus/post/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus/post/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus/post/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus/post/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus/post/responses/401/content/application~1json/examples/default"},"paths/~1skus/post/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus/post/responses/403/content/application~1json/examples/default"},"paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict":{"value":{"success":false,"errors":{"merchant_order_id":["a record with this data already exists"]}},"key":"validation_conflict","summary":"Validation conflict (legacy format)","id":"paths/~1skus/post/responses/409/content/application~1json/examples/validation_conflict"},"paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict":{"value":{"success":false,"title":"Conflict","status":409,"errors":["A record with this data already exists"]},"key":"general_conflict","summary":"General conflict","id":"paths/~1skus/post/responses/409/content/application~1json/examples/general_conflict"},"paths/~1skus/post/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus/post/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus/post/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus/post/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus/post/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus/post/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/delete/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/delete/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/delete/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/delete/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/get/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/get/responses/429/content/application~1json/examples/default"},"paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1{id}/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/patch/responses/401/content/application~1json/examples/default"},"paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/patch/responses/403/content/application~1json/examples/default"},"paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/patch/responses/404/content/application~1json/examples/default"},"paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict":{"value":{"success":false,"errors":{"merchant_order_id":["a record with this data already exists"]}},"key":"validation_conflict","summary":"Validation conflict (legacy format)","id":"paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/validation_conflict"},"paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict":{"value":{"success":false,"title":"Conflict","status":409,"errors":["A record with this data already exists"]},"key":"general_conflict","summary":"General conflict","id":"paths/~1skus~1{id}/patch/responses/409/content/application~1json/examples/general_conflict"},"paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1{id}/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1{id}/patch/responses/429/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1by_sku_code/get/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/get/responses/401/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/get/responses/403/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/get/responses/404/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/get/responses/429/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1by_sku_code/patch/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/patch/responses/401/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/patch/responses/403/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/patch/responses/404/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/validation_errors":{"value":{"success":false,"errors":{"name":["can't be blank"],"sku_code":["can't be blank"]}},"key":"validation_errors","summary":"Field validation errors (legacy format)","id":"paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/validation_errors"},"paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/detailed_validation":{"value":{"success":false,"title":"Validation Error","status":422,"errors":[{"message":"Name can't be blank","code":"blank","pointer":"/name"},{"message":"SKU code can't be blank","code":"blank","pointer":"/sku_code"}]},"key":"detailed_validation","summary":"Detailed validation errors","id":"paths/~1skus~1by_sku_code/patch/responses/422/content/application~1problem+json/examples/detailed_validation"},"paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/patch/responses/429/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/openapi_validation":{"value":{"success":false,"title":"Bad Request Body","status":400,"errors":[{"message":"value at `/data/name` is not a string","pointer":"/data/name","code":"string"},{"message":"number at `/data/numberOfLegs` is less than: 2","pointer":"/data/numberOfLegs","code":"minimum"}]},"key":"openapi_validation","summary":"OpenAPI validation error","id":"paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/openapi_validation"},"paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/general_bad_request":{"value":{"success":false,"title":"Bad Request","status":400,"errors":["bad request"]},"key":"general_bad_request","summary":"General bad request","id":"paths/~1skus~1by_sku_code/delete/responses/400/content/application~1problem+json/examples/general_bad_request"},"paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/delete/responses/401/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/delete/responses/403/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default":{"value":{"success":false,"title":"Not Found","status":404,"errors":["Record not found"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/delete/responses/404/content/application~1json/examples/default"},"paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1skus~1by_sku_code/delete/responses/429/content/application~1json/examples/default"},"paths/~1sales_channels/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1sales_channels/get/responses/401/content/application~1json/examples/default"},"paths/~1sales_channels/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1sales_channels/get/responses/403/content/application~1json/examples/default"},"paths/~1sales_channels/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1sales_channels/get/responses/429/content/application~1json/examples/default"},"paths/~1shipments/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1shipments/get/responses/401/content/application~1json/examples/default"},"paths/~1shipments/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1shipments/get/responses/403/content/application~1json/examples/default"},"paths/~1shipments/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1shipments/get/responses/429/content/application~1json/examples/default"},"paths/~1warehouses/get/responses/401/content/application~1json/examples/default":{"value":{"success":false,"title":"Unauthorized","status":401,"errors":["Authentication required"]},"key":"default","summary":"default","id":"paths/~1warehouses/get/responses/401/content/application~1json/examples/default"},"paths/~1warehouses/get/responses/403/content/application~1json/examples/default":{"value":{"success":false,"title":"Forbidden","status":403,"errors":["Access denied"]},"key":"default","summary":"default","id":"paths/~1warehouses/get/responses/403/content/application~1json/examples/default"},"paths/~1warehouses/get/responses/429/content/application~1json/examples/default":{"value":{"success":false,"title":"Too Many Requests","status":429,"errors":["Rate limit exceeded"]},"key":"default","summary":"default","id":"paths/~1warehouses/get/responses/429/content/application~1json/examples/default"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"token","description":"A merchant-scoped API token used to authenticate all API requests.\n\nThis token provides access to all sales channels owned by the merchant.\n"}},"servers":[{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","isMockServer":true,"description":"Mock server"},{"url":"https://app.hive.app/merchant_api/v2","description":"Production API"},{"url":"https://staging.app.hive.app/merchant_api/v2","description":"Staging API"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/merchant-api-v2/mapi_v2_oas31","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/Merchant API v2/mapi_v2_oas31.json?download"},{"url":"/_bundle/Merchant API v2/mapi_v2_oas31.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Merchant API v2","description":"The Merchant API v2 provides programmatic access to merchant data\nacross all their sales channels.\n\nThis version shifts from sales channel-scoped access to merchant-scoped access,\nallowing access to data across all sales channels owned by a single merchant.\n\nThe access tokens remain the same as in v1, but now they provide access to all sales channels.\n\n## Rate Limiting\nAll endpoints are rate limited to 100 requests per minute per merchant. The following headers are included in every response:\n- `X-Rate-Limit-Used`: The number of requests used in the current minute.\n- `X-Rate-Limit-Max`: The maximum number of requests allowed per minute (100).\nIf the limit is exceeded, a 429 Too Many Requests response is returned.\n\n## Versioning and Deprecation Policy\nv1 of the Merchant API will remain available as long as clients use it, but new features and improvements will only be added to v2. We recommend all new integrations use v2.\n\n## Pagination\nAll list endpoints use cursor-based pagination. The `pagination.next_page_url` field in the response indicates the next page. If `null`, there are no more results. Use the `limit` query parameter to control page size. See each endpoint's response schema for details.\n\n## Webhooks\nHive sends webhook notifications to inform you about important events in your merchant account. Configure webhook endpoints in your merchant dashboard. See the `webhooks` section below for available webhook events and their payloads.\n\n### Webhook Security\nHive signs all webhook requests with an `x-hive-signature` header to prevent\nmalicious actors from sending invalid requests. This header contains a hex-encoded HMAC-SHA256\ndigest of the request body, using your API token as the key. Requests without this header or\nwith invalid signatures should be ignored.\n\n**Ruby signature validation example**:\n```ruby\ndef request_valid?(req)\n  return false if !req.post?\n  request_sig = req.get_header(\"x-hive-signature\")\n  expected_sig = OpenSSL::HMAC.hexdigest(\"sha256\", ENV[\"API_TOKEN\"], req.body)\n  Rack::Utils.secure_compare(request_sig, expected_sig)\nend\n```\n\n### Webhook Reliability\nWebhook URLs should be idempotent as Hive cannot guarantee the order of calls\nor retry attempts for the same event. What this means in practice, is that you should check the\ntimestamp of the object in the payload. Ignore payloads with a timestamp older than the last\nupdate you saved. Only process the webhook if the updated timestamp is newer than the one you\nhave on file.\n"}},"baseSlug":"/merchant-api-v2/mapi_v2_oas31","routesMapping":{}}