{"items":[{"type":"group","label":"Merchant API v1","items":[{"type":"link","label":"Merchant API v1","link":"/merchant-api-v1/mapi_v1_oas31","routeSlug":"/merchant-api-v1/mapi_v1_oas31"},{"type":"link","label":"Versioning","link":"/merchant-api-v1/mapi_v1_oas31/section/versioning","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/versioning"},{"type":"link","label":"Access tokens","link":"/merchant-api-v1/mapi_v1_oas31/section/access-tokens","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/access-tokens"},{"type":"link","label":"Requests","link":"/merchant-api-v1/mapi_v1_oas31/section/requests","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/requests"},{"type":"link","label":"Errors","link":"/merchant-api-v1/mapi_v1_oas31/section/errors","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/errors"},{"type":"link","label":"Pagination","link":"/merchant-api-v1/mapi_v1_oas31/section/pagination","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/pagination"},{"type":"link","label":"Rate Limiting","link":"/merchant-api-v1/mapi_v1_oas31/section/rate-limiting","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/rate-limiting"},{"type":"link","label":"Webhooks","link":"/merchant-api-v1/mapi_v1_oas31/section/webhooks","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/webhooks"},{"type":"link","label":"Webhook Security","link":"/merchant-api-v1/mapi_v1_oas31/section/webhook-security","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/webhook-security"},{"type":"link","label":"Webhook Reliability","link":"/merchant-api-v1/mapi_v1_oas31/section/webhook-reliability","routeSlug":"/merchant-api-v1/mapi_v1_oas31/section/webhook-reliability"},{"type":"group","label":"Orders","link":"/merchant-api-v1/mapi_v1_oas31/orders","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/listorders","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/listorders","metadata":{"seo":{"title":"List orders","description":"Returns the orders of the sales channel, newest first. Orders created manually in the Hive app are not included."}},"httpPath":"/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/createorder","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/createorder","metadata":{"seo":{"title":"Create an order","description":"Creates an order. Hive fulfills it unless its destination country is blocked for the sales channel."}},"httpPath":"/orders"},{"label":"Get an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/getorder","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/getorder","metadata":{"seo":{"title":"Get an order","description":"Returns one order of the sales channel."}},"httpPath":"/orders/{id}"},{"label":"Update an order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/updateorder","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/updateorder","metadata":{"seo":{"title":"Update an order","description":"Updates an order. Properties you leave out keep their current value, and so do most properties sent as null (see the request body); shipping_address is merged property by property."}},"httpPath":"/orders/{id}"},{"label":"Update an order (PUT)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/updateorderwithput","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/updateorderwithput","metadata":{"seo":{"title":"Update an order (PUT)","description":"The same as PATCH /orders/{id}, which is the documented method. PUT is accepted too and behaves identically, including merging the properties you leave out."}},"httpPath":"/orders/{id}"},{"label":"Cancel an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/orders/cancelorder","routeSlug":"/merchant-api-v1/mapi_v1_oas31/orders/cancelorder","metadata":{"seo":{"title":"Cancel an order","description":"Cancels an order that Hive has not started fulfilling yet. The order's status becomes unfulfillable."}},"httpPath":"/orders/{id}/cancel"}]},{"type":"group","label":"RestockingShipments","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments","items":[{"label":"List restocking shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/listrestockingshipments","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/listrestockingshipments","metadata":{"seo":{"title":"List restocking shipments","description":"Returns the merchant's restocking shipments, newest first. Only restocking shipments with at least one item of a SKU the merchant's sales channels know are included."}},"httpPath":"/restocking_shipments"},{"label":"Create a restocking shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/createrestockingshipment","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/createrestockingshipment","metadata":{"seo":{"title":"Create a restocking shipment","description":"Announces a restocking shipment to a Hive warehouse. The new restocking shipment has the status shipped."}},"httpPath":"/restocking_shipments"},{"label":"Get a restocking shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/getrestockingshipment","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/getrestockingshipment","metadata":{"seo":{"title":"Get a restocking shipment","description":"Returns one of the merchant's restocking shipments."}},"httpPath":"/restocking_shipments/{id}"},{"label":"Update a restocking shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/updaterestockingshipment","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/updaterestockingshipment","metadata":{"seo":{"title":"Update a restocking shipment","description":"Updates a restocking shipment while its status is created or shipped; in any other status the update is answered with 422 Unprocessable Entity."}},"httpPath":"/restocking_shipments/{id}"},{"label":"Cancel a restocking shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/cancelrestockingshipment","routeSlug":"/merchant-api-v1/mapi_v1_oas31/restockingshipments/cancelrestockingshipment","metadata":{"seo":{"title":"Cancel a restocking shipment","description":"Cancels a restocking shipment whose status is created, shipped, delivered, arrived or on_hold. In any other status the cancellation is answered with 422 Unprocessable Entity."}},"httpPath":"/restocking_shipments/{id}/cancel"}]},{"type":"group","label":"Returns","link":"/merchant-api-v1/mapi_v1_oas31/returns","routeSlug":"/merchant-api-v1/mapi_v1_oas31/returns","items":[{"label":"List returns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/returns/listreturns","routeSlug":"/merchant-api-v1/mapi_v1_oas31/returns/listreturns","metadata":{"seo":{"title":"List returns","description":"Returns the returns of the orders of all the merchant's sales channels, newest first. Only returns whose order is also a Merchant API order (one /orders can return) are listed; returns of orders that reached Hive any other way are not."}},"httpPath":"/returns"},{"label":"Get a return","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/returns/getreturn","routeSlug":"/merchant-api-v1/mapi_v1_oas31/returns/getreturn","metadata":{"seo":{"title":"Get a return","description":"Returns one of the merchant's returns."}},"httpPath":"/returns/{id}"}]},{"type":"group","label":"SKUs","link":"/merchant-api-v1/mapi_v1_oas31/skus","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus","items":[{"label":"List SKUs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/listskus","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/listskus","metadata":{"seo":{"title":"List SKUs","description":"Returns the SKUs of the sales channel in every status, including deleted ones, newest first."}},"httpPath":"/skus"},{"label":"Create a SKU","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/createsku","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/createsku","metadata":{"seo":{"title":"Create a SKU","description":"Creates a SKU, or updates the sales channel's SKU with the same merchant_sku_id if there is one; either way the SKU is active afterwards and the response is 201 Created."}},"httpPath":"/skus"},{"label":"Create or update SKUs in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/bulkupsertskus","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/bulkupsertskus","metadata":{"seo":{"title":"Create or update SKUs in bulk","description":"Creates or updates up to 100 SKUs in one request. Each item of skus has the same properties as the body of POST /skus and is matched to an existing SKU by merchant_sku_id; when two items share a merchant_sku_id, only the first is used."}},"httpPath":"/skus/bulk_upsert"},{"label":"Update a SKU","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/updatesku","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/updatesku","metadata":{"seo":{"title":"Update a SKU","description":"Updates a SKU of the sales channel. The properties you leave out keep their value, and a null batch_tracking_enabled is ignored. The SKU is active afterwards, even if it was deleted."}},"httpPath":"/skus/{id}"},{"label":"Update a SKU (PUT)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/updateskuwithput","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/updateskuwithput","metadata":{"seo":{"title":"Update a SKU (PUT)","description":"The same as PATCH /skus/{id}, which is the documented method. PUT is accepted too and behaves identically, including keeping the properties you leave out."}},"httpPath":"/skus/{id}"},{"label":"Delete a SKU","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/skus/deletesku","routeSlug":"/merchant-api-v1/mapi_v1_oas31/skus/deletesku","metadata":{"seo":{"title":"Delete a SKU","description":"Marks an active SKU as deleted. The next create, update or bulk upsert of the SKU makes it active again. A SKU that is not active (already deleted, archived or a draft) is answered with 404 Not Found."}},"httpPath":"/skus/{id}"}]},{"type":"group","label":"Shipments","link":"/merchant-api-v1/mapi_v1_oas31/shipments","routeSlug":"/merchant-api-v1/mapi_v1_oas31/shipments","items":[{"label":"List shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/shipments/listshipments","routeSlug":"/merchant-api-v1/mapi_v1_oas31/shipments/listshipments","metadata":{"seo":{"title":"List shipments","description":"Returns the shipped shipments of the sales channel's orders, newest first. Shipments that have not been shipped yet are not listed; their status changes are available through the shipment_status_updated webhook."}},"httpPath":"/shipments"}]},{"type":"group","label":"Warehouses","link":"/merchant-api-v1/mapi_v1_oas31/warehouses","routeSlug":"/merchant-api-v1/mapi_v1_oas31/warehouses","items":[{"label":"List warehouses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/warehouses/listwarehouses","routeSlug":"/merchant-api-v1/mapi_v1_oas31/warehouses/listwarehouses","metadata":{"seo":{"title":"List warehouses","description":"Returns all the merchant's warehouses. This list is not paginated."}},"httpPath":"/warehouses"}]},{"type":"group","label":"Webhooks","link":"/merchant-api-v1/mapi_v1_oas31/webhooks","routeSlug":"/merchant-api-v1/mapi_v1_oas31/webhooks","items":[{"label":"Shipment delivery status updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/webhooks/deliverystatusupdatedwebhook","routeSlug":"/merchant-api-v1/mapi_v1_oas31/webhooks/deliverystatusupdatedwebhook","metadata":{"seo":{"title":"Shipment delivery status updated","description":"Sent when the carrier reports a new delivery status for a shipment. The payload is the shipment as GET /shipments returns it, with the new delivery_status."}},"httpPath":"delivery_status_updated"},{"label":"Shipment status updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/webhooks/shipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v1/mapi_v1_oas31/webhooks/shipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Shipment status updated","description":"Sent when a shipment moves to another fulfillment status. The payload is the shipment as GET /shipments returns it, with the new status. Unlike GET /shipments, which only lists shipped shipments, this event is sent for every status."}},"httpPath":"shipment_status_updated"},{"label":"Restocking shipment status updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/webhooks/restockingshipmentstatusupdatedwebhook","routeSlug":"/merchant-api-v1/mapi_v1_oas31/webhooks/restockingshipmentstatusupdatedwebhook","metadata":{"seo":{"title":"Restocking shipment status updated","description":"Sent when a restocking shipment moves to another status. The payload is the restocking shipment as GET /restocking_shipments/{id} returns it. Restocking shipments belong to the merchant, so the event is sent to every sales channel of the merchant that registered a URL for it."}},"httpPath":"restocking_shipment_status_updated"},{"label":"Return status updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/merchant-api-v1/mapi_v1_oas31/webhooks/returnstatusupdatedwebhook","routeSlug":"/merchant-api-v1/mapi_v1_oas31/webhooks/returnstatusupdatedwebhook","metadata":{"seo":{"title":"Return status updated","description":"Sent when a return moves to another status. The payload is the return as GET /returns/{id} returns it. The event goes to the sales channel of the returned order."}},"httpPath":"return_status_updated"}]}]},{"type":"group","label":"Merchant API v2","items":[{"type":"link","label":"Merchant API v2","link":"/merchant-api-v2/mapi_v2_oas31","routeSlug":"/merchant-api-v2/mapi_v2_oas31"},{"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"},{"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"},{"type":"link","label":"Pagination","link":"/merchant-api-v2/mapi_v2_oas31/section/pagination","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/pagination"},{"type":"link","label":"Webhooks","link":"/merchant-api-v2/mapi_v2_oas31/section/webhooks","routeSlug":"/merchant-api-v2/mapi_v2_oas31/section/webhooks"},{"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"},{"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"},{"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."}},"httpPath":"/inventory/transactions"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/skus/{sku_id}/inventory_batch_settings"}]},{"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."}},"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."}},"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."}},"httpPath":"/skus/{sku_id}/inventory_batches/{id}/unblock"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/inventory_transfer_orders/{id}/cancel"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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"}},"httpPath":"inventory_transfer_order.status_updated"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/orders/by_merchant_order_id"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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"}},"httpPath":"order.status_updated"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/restocking_shipments/{id}/cancel"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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"}},"httpPath":"restocking_shipment.status_updated"}]},{"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."}},"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."}},"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 anySKU-specific overrides."}},"httpPath":"/return_rules"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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"}},"httpPath":"return.status_updated"}]},{"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."}},"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\"."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/skus/by_sku_code"}]},{"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."}},"httpPath":"/sales_channels"}]},{"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."}},"httpPath":"/shipments"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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"}},"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"}},"httpPath":"shipment.delivery_status_updated"}]},{"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."}},"httpPath":"/warehouses"}]},{"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"}},"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"}},"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"}},"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"}},"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"}},"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"}},"httpPath":"inventory_transfer_order.status_updated"}]}]}]}