# ShipMonk API Documentation > The ShipMonk API enables developers to build custom integrations between ShipMonk and third-party software. ## Guides: documentation - [Introduction](https://apidocs.shipmonk.com/docs/intro.md) - [Key Concepts](https://apidocs.shipmonk.com/docs/concepts.md): ShipMonk App Core Concepts - [Obtaining Your API key](https://apidocs.shipmonk.com/docs/api-key.md) - [Terminology](https://apidocs.shipmonk.com/docs/definitions.md) ## Guides: Common Use Cases - [Retrieve a List of Products](https://apidocs.shipmonk.com/docs/retrieving-a-list-of-products.md) - [Creating an Order](https://apidocs.shipmonk.com/docs/creating-an-order.md): This guide will walk you through creating an order for the first time using the ShipMonk API. - [Sync ShipMonk Inventory Levels](https://apidocs.shipmonk.com/docs/sync-shipmonk-inventory-levels.md) ## API Reference: Useful information - [Getting Started](https://apidocs.shipmonk.com/reference/common.md): The ShipMonk API enables developers to build custom integrations between ShipMonk and third-party software. ## API Reference: Shipmonk API - [Webhooks](https://apidocs.shipmonk.com/reference/webhooks.md) - [Shipment Notification](https://apidocs.shipmonk.com/reference/webhook-order-shipment-notification.md): Once the order is fulfilled, ShipMonk can notify the 3rd party software of such event via webhook or Marketplace via direct integration. The payload consists of tracking and packing information.… - [Order status change](https://apidocs.shipmonk.com/reference/webhook-order-status-change.md): As an order progresses from initial import to full fulfillment, it transitions through multiple statuses. ShipMonk can notify external systems of these status changes via webhooks. ## Supported… - [Return status change](https://apidocs.shipmonk.com/reference/webhook-return-status-change.md): ## Supported Return Webhooks All return-related webhooks are closely tied to the status of the return. Each webhook is triggered by a specific status transition, marking important stages in the… - [Receiving status change](https://apidocs.shipmonk.com/reference/webhook-receiving-status-change.md): ## Supported Receiving Webhooks All receiving-related webhooks are closely tied to the status of the receiving. Each webhook is triggered when the receiving transitions to a specific `status`,… - Receivings - [Create or Update Receiving](https://apidocs.shipmonk.com/reference/post-v1-integrations-receiving.md): ## General description - ERP push to ShipMonk - `items.[].lot` or any of its property can be null ## ASN & Receiving Key - When updating a Receiving, the identifying properties are `receiving_key`… - [Retrieve List of Receivings](https://apidocs.shipmonk.com/reference/get-v1-integrations-receivings-list.md) - [Get Receiving](https://apidocs.shipmonk.com/reference/get-v1-integrations-receiving.md): ## ASN & Receiving Key When retrieving a Receiving, you must supply either the receivingKey or asn parameter. - If both are supplied, they must both match a single Receiving. - Supplying only one of… - [Complete Receiving](https://apidocs.shipmonk.com/reference/post-v1-integrations-sandbox-complete-receiving.md): Simulates the completion of a receiving in your Sandbox environment. This action is available for testing purposes only and cannot be used in production. The simulation is processed asynchronously.… - [Retrieve List of Receipts](https://apidocs.shipmonk.com/reference/get-v1-integrations-receipts-list.md) - Returns - [Create or Update Return](https://apidocs.shipmonk.com/reference/post-v1-integrations-returns.md) - [Retrieve List of Returns](https://apidocs.shipmonk.com/reference/get-v1-integrations-returns-list.md) - [Get Return](https://apidocs.shipmonk.com/reference/get-v1-integrations-returns.md): DEPRECATED – please use Retrieve List of Returns instead with filter for RMA. - [Complete Return](https://apidocs.shipmonk.com/reference/post-v1-integrations-sandbox-complete-return.md): This endpoint simulates the full return lifecycle on Sandbox environment. It can't be used in production! The return goes through arrival, check-in, receiving, grading, and completion based on the… - Orders - [Create or Update Order](https://apidocs.shipmonk.com/reference/post-v1-integrations-order.md): This endpoint can be used to create an order. The orders are typically pushed to ShipMonk from the 3rd party software. The Create Order endpoint does not create duplicate entries when both the… - [Get Order](https://apidocs.shipmonk.com/reference/get-v1-integrations-orders.md): This endpoint can be used to retrieve data from the order you are calling.The order can be in following 4 statuses (field order_status): - `unfulfilled` indicates an order is ready for ShipMonk to… - [Retrieve List of Orders](https://apidocs.shipmonk.com/reference/get-v1-integrations-orders-list.md): When no filters are specified, the endpoint will return up to the first 1,000,000 orders, based on selected ordering. If filters are used, this endpoint will return a maximum of 10,000 orders. - [Complete Order](https://apidocs.shipmonk.com/reference/post-v1-integrations-sandbox-complete-order.md): Simulates warehouse shipment of an order in your Sandbox environment. Cannot be used in production. The order must be in a submitted status with available inventory, a valid address, and a valid… - [Submit Order](https://apidocs.shipmonk.com/reference/post-v1-integrations-submit-order.md): Submits an order for fulfillment or reschedules its submit date. Submitting an order makes it eligible for the operations team to begin fulfillment. Once submitted, the order enters the fulfillment… - Products - [Retrieve List of Products](https://apidocs.shipmonk.com/reference/get-v1-products.md): Results are not guaranteed to be consistent across paginated calls. As inventory is updated during fulfillment, products shift position in the sort order and may reappear on later pages. For… - [Create Product](https://apidocs.shipmonk.com/reference/post-v1-integrations-product.md): This endpoint allows merchants to create products within ShipMonk. Once created, product data is immutable via API — updates must be made via the ShipMonk web app. SKUs must be unique within the… - [Products for Inventory Sync](https://apidocs.shipmonk.com/reference/post-v1-integrations-products-search.md): Search for products based on a set of filters and sorting criteria. A cursor is returned that can be used by /integrations/products/search/paginate endpoint to iterate through the results. The… - [Fetch results from Products for Inventory Sync](https://apidocs.shipmonk.com/reference/get-v1-integrations-products-search-paginate.md): Iterate over results from /integrations/products/search endpoint using the returned cursor or using the cursor provided by response of this request as nextCursor. The response is the same as the… - Inventory Holds - [Create Inventory Hold](https://apidocs.shipmonk.com/reference/post-v1-integrations-inventory-hold.md): Creates an inventory hold, which keeps the held units from being shipped. ## General description - Currently every hold is placed on an Advance Shipping Notice (ASN): it covers products expected on… - [Release Inventory Hold](https://apidocs.shipmonk.com/reference/post-v1-integrations-inventory-hold-release.md): Releases the whole inventory hold, so the held units can be shipped again. ## General description - Unlike creating and updating a hold, releasing works in any receiving `status`, also once… - [Update Inventory Hold](https://apidocs.shipmonk.com/reference/post-v1-integrations-inventory-hold-update.md): Replaces the products covered by an inventory hold placed on an ASN, addressed by its `inventory_hold_uuid`. The hold may have been created through this API or set up for you in the ShipMonk app. ##… - [Retrieve List of Inventory Holds](https://apidocs.shipmonk.com/reference/get-v1-integrations-inventory-holds-list.md): Returns the inventory holds placed on the account's ASNs, newest first, including the released and cancelled ones. ## General description - Holds set up for you in the ShipMonk app are listed as… - Warehouses - [Retrieve List of Warehouses](https://apidocs.shipmonk.com/reference/get-v1-integrations-warehouses.md): Returns all enabled warehouses for the account associated with your API key. Warehouse IDs and identifiers are required across various endpoints and can be included in query parameters to filter… - Claims - [File Fulfillment Claim](https://apidocs.shipmonk.com/reference/post-v1-integrations-claims-fulfillment.md): Files a fulfillment claim. Claims for wholesale orders shipped without a shipping label (e.g. LTL) cannot be filed via this endpoint; file them in the ShipMonk app instead. Several fields are… - [File Shipping Claim](https://apidocs.shipmonk.com/reference/post-v1-integrations-claims-shipping.md): Files a shipping claim. Claims for wholesale orders shipped without a shipping label (e.g. LTL) cannot be filed via this endpoint; file them in the ShipMonk app instead. Several fields are… ## Changelog - [v1.038](https://apidocs.shipmonk.com/changelog/v1-038.md) - [v1.037](https://apidocs.shipmonk.com/changelog/v1-037.md) - [v1.036](https://apidocs.shipmonk.com/changelog/v1-036.md) - [v1.035](https://apidocs.shipmonk.com/changelog/v1-035.md) - [v1.034](https://apidocs.shipmonk.com/changelog/v1-034.md) - [v1.033](https://apidocs.shipmonk.com/changelog/v1-033.md) - [v1.032](https://apidocs.shipmonk.com/changelog/v1-032.md) - [v1.031](https://apidocs.shipmonk.com/changelog/v1-031.md) - [v1.030](https://apidocs.shipmonk.com/changelog/v1-030.md) - [v1.029](https://apidocs.shipmonk.com/changelog/v1-029.md)