Skip to main content
POST
/
v1
/
shipping
/
shipments
/
{id}
/
process
Process Shipment
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pick_locations": [
    {
      "location_label": "<string>",
      "quantity": 123
    }
  ]
}
'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer
required

The id of the referenced Shipment.

Required range: x >= 1

Body

application/json
​
pick_locations
PickupLocation · object[]
write-only

Optionally specify the exact locations to which the shipment items should be reserved.

Response

OK - The operation completed successfully and there is no response body.