# shipment.created

A shipment was created. `data.orders` lists the orders on it.

Endpoint: POST shipment.created
Version: 1.19
Security: ApiKey, ApiSecret, UserGuid, UserToken, SupplierGuid

## Security:

  - `ApiKey` (unknown)
    apiKey in header x-apiKey

  - `ApiSecret` (unknown)
    apiKey in header x-apiSecret

  - `UserGuid` (unknown)
    apiKey in header userGuid

  - `UserToken` (unknown)
    apiKey in header userToken

  - `SupplierGuid` (unknown)
    apiKey in header supplierGuid

## Request fields (application/json):

  - `id` (string, required)
    Delivery id. Use it as an idempotency key: a retry or a manual redelivery carries the same id.

  - `type` (string, required)
    Event type, e.g. `order.submitted`.

  - `api_version` (string, required)
    Example: 2026-10-27

  - `occurred_at` (string, required)
    When the event happened. Deliveries are not ordered; compare `occurred_at` (and the resource's `updated_at`) when ordering matters.

  - `supplier_guid` (string, required)
    GUID of the supplier account the event belongs to.

  - `test` (boolean)
    Present and true for deliveries made with the "send test" action.

  - `data` (object, required)
    `data` for the shipment events.

  - `data.guid` (string)

  - `data.name` (string)

  - `data.status` (string)

  - `data.carrier` (string)

  - `data.tracking` (string)

  - `data.shipment_date` (string)

  - `data.is_voided` (boolean)

  - `data.is_partial` (boolean)

  - `data.weight` (number)

  - `data.note` (string)

  - `data.customer` (object)
    A related record named by guid.

  - `data.customer.guid` (string)

  - `data.customer.name` (string)

  - `data.ship_to` (object)

  - `data.ship_to.guid` (string)

  - `data.ship_to.name` (string)

  - `data.ship_to.company_name` (string)

  - `data.ship_to.address_line_one` (string)

  - `data.ship_to.address_line_two` (string)

  - `data.ship_to.address_line_three` (string)

  - `data.ship_to.city` (string)

  - `data.ship_to.state` (string)

  - `data.ship_to.postal_code` (string)

  - `data.ship_to.country` (string)

  - `data.ship_to.phone` (string)

  - `data.ship_to.email` (string)

  - `data.ship_to.address_internal_id` (string)

  - `data.orders` (array)

  - `data.orders.guid` (string)

  - `data.orders.number` (string)

  - `data.created_at` (string)

  - `data.updated_at` (string)

## Response 200:

  - `200` (unknown)
    Return any 2xx to acknowledge. Anything else, or no answer within 10 seconds, is retried.