v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Orders

Complete Order

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 shipping method.

A shipment notification is sent after the delay configured for the store under Account Settings > Stores, defaulting to 20 minutes.

For D2C orders, there is approximately a 1-minute delay (up to 5 minutes) between the order transitioning from awaiting pick up to en route. During this window, an awaiting shipment webhook is delivered to simulate the real fulfillment process.

You can also simulate order completion directly in the ShipMonk UI. See our Sandbox guide for instructions.

post/v1/integrations/sandbox/complete-order

Request body

order_keystring required

Unique identifier of the order in the external (caller's) system, as originally supplied when the order was created.

store_idinteger required

Identifier of the store this return belongs to.

pack_type'singlepack' | 'multipack'

Example request

{
  "order_key": "327b5abd-017a-4504-a50d-54f1cea80269",
  "store_id": 123456
}

Response

Success

statusinteger required