ST26 - Validate shipments as ready to pick up

Request

Description

Limited to 1000 shipments at a time

Call Frequency

Recommended usage: On each shipment ready to pick up

Maximum usage: On each shipment ready to pick up

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Query

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json

shipmentsArray of objects, [ 1 .. 1000 ] itemsrequired

Shipment ids

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments/ready_for_pick_up?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce"
      },
      {
        "id": "c8ca3759-a81b-4abe-afd0-93a418e83ae8"
      },
      {
        "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

shipment_errorsArray of objects

Shipment workflow update errors

shipment_successArray of objects

Shipment workflow update success

Response

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … },
    { … }
  ]
}