orders.cargo.book

Accept a carrier offer, create the label and ship the order.

• method + path: POST /v1/orders/{ord}/cargo/book
• TR label: Kargo teklifi onaylanıp gönderildi
• auth: authenticated · scope gates: any of admin, orders:read, orders:write — “Siparişleri yalnızca mağaza sahibi görebilir”; then any of admin, orders:write — “Bu işlem için yetki yok”
• agentPolicy: propose — a live mutation — an Ajan token's call is recorded into its open proposal (202 proposed: true); a Geliştirici token executes it directly.
• effects: db, provider, mail
• idempotency: server — the platform derives the key
• wraps: order.ship

Machine-readable body schema: /schemas/routes/orders.cargo.book.json.

Body

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "providerShipmentId": {
      "type": "string",
      "minLength": 6,
      "maxLength": 80
    },
    "offerId": {
      "type": "string",
      "minLength": 6,
      "maxLength": 80
    },
    "extensionId": {
      "type": "string",
      "pattern": "^[a-z0-9-]+\\.[a-z0-9-]+$"
    }
  },
  "required": [
    "providerShipmentId",
    "offerId"
  ],
  "additionalProperties": false
}