Receivings

Complete Receiving

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. A 200 response means the receiving was accepted and moved to in_progress; the result is visible via GET /v1/integrations/receiving (status received, received_at) or the Receiving status change webhook once the simulation finishes.

Use the completion_mode field to control how the simulation behaves: fully_received accepts all expected units, while short_received, excess_received, and partially_received simulate discrepancies that may leave the receiving open or generate exceptions.

A receiving can be simulated only once. A partially_received run leaves the receiving in progress and it cannot be simulated again.

ASN & Receiving Key

To identify the target receiving, you must supply either receiving_key or asn.

post/v1/integrations/sandbox/complete-receiving

Request

  • Base URL: https://api.shipmonk.com
  • URL: https://api.shipmonk.com/v1/integrations/sandbox/complete-receiving
  • Auth: API key in header Api-Key

Request body

receiving_keystring nullable

Caller-supplied unique identifier of the receiving (purchase order). Either receiving_key or asn must be provided to identify the target receiving.

asnstring nullable

Optional filter to retrieve a receiving by its Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.

completion_mode'fully_received' | 'short_received' | 'excess_received' | 'partially_received' required

Example request

{
  "receiving_key": "key-123",
  "asn": "ASN-12345"
}

Response

Success

statusinteger required

Changes

No recorded changes to this operation across all 16 revisions of this API.