API Reference

Complete Receiving

post
https://api.shipmonk.com/v1/integrations/sandbox/complete-receiving

This action is available only at Sandbox environment for testing purposes! It is not possible to complete order which is in the state Action Required.

Receiving is proccessed and all items are received.

ASN & Receiving Key

  • When completing a Receiving, you must supply either receiving_key or asn parameter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

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

string | null

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

string
enum
required

How the sandbox should simulate completion: 'fully_received' (all expected units), 'short_received' (fewer than expected), 'excess_received' (more than expected), or 'partially_received' (partial completion that leaves the receiving open).

Allowed:
Response

Updated about 1 month ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago