ST06 - Delete shipments

Request

Description

Limited to 1000 shipments at a time

Call Frequency

Recommended usage: On each shipment deletion

Maximum usage: On each shipment deletion

More context

Security

Front-Bearer-Token or OAuth-2

Bodyapplication/json

shipmentsArray of objects, [ 1 .. 1000 ] itemsrequired

Shipment ids

curl -i -X PUT \
  https://your-instance.mirakl.net/api/shipments/delete \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "e2055970-dd6c-4d66-b005-096d6e6e0f30"
      },
      {
        "id": "89174558-2845-44ef-bd57-78db027947f7"
      },
      {
        "id": "14d134a1-eb3a-442c-b16c-05a35486d1bf"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

shipment_errorsArray of objects

Shipment workflow update errors

shipment_successArray of objects

Shipment workflow update success

Response

{
  "deletion_errors": [
    { … },
    { … }
  ],
  "deletion_success": [
    { … }
  ]
}