v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB

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.

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.

ASN & Receiving Key

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

post/v1/integrations/sandbox/complete-receiving

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