ST07 - Update shipment shipping origin

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

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 .. 100 ] itemsrequired

Shipments list

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "5b2269b6-3918-43bc-9262-fddd815398f3",
        "shipping_from": {
          "warehouse": {
            "code": "WHC1"
          }
        }
      },
      {
        "id": "0e450a4c-704f-4e2c-845a-71b65b4ff16a",
        "shipping_from": {
          "warehouse": {
            "code": "WHC2"
          }
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json

shipment_errorsArray of objectsrequired

Shipment update errors

shipment_successArray of objectsrequired

Shipment update success

Response

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