ST31 - Update shipment additional information

Request

Description

Limited to 100 shipments at a time

Call Frequency

Recommended usage: At each update of shipments for one or multiple shipments

Maximum usage: At each update of shipments for one or multiple shipments

Security

Operator-Bearer-Token or OAuth-2

Bodyapplication/json

shipmentsArray of objects, [ 1 .. 100 ] itemsrequired

List of shipments additional information

curl -i -X PUT \
  https://your-instance.mirakl.net/api/shipments/additional_information \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "4dd549d5-3b5b-4237-a77c-a084359f93z",
        "shipment_additional_information": [
          {
            "code": "IMEI",
            "type": "STRING",
            "value": "38021999921000"
          },
          {
            "code": "DELIVERY_BILL_ID",
            "type": "STRING",
            "value": "invalid value with spaces"
          }
        ]
      },
      {
        "id": "245365B0-D003-4DB7-B23F-5C0A48E93E53",
        "shipment_additional_information": [
          {
            "code": "DELIVERY_BILL_DATE",
            "type": "DATE",
            "value": "2024-01-01"
          },
          {
            "code": "DELIVERY_BILL_ID",
            "type": "STRING",
            "value": "IUYHJ777-98"
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json

shipment_update_errorsArray of objects

Shipment additional information update errors

shipment_update_successArray of objects

Shipment additional information update success

Response

{
  "shipment_update_errors": [
    { … }
  ],
  "shipment_update_success": [
    { … }
  ]
}