# Create a shipment event

When a shipment status changes (e.g. it is shipped or out for delivery), notify Onward of that event.

Endpoint: POST /shipments/{shopShipmentId}/events
Version: 1.0.0
Security: api_key

## Header parameters:

  - `Content-Type` (string, required)
    Content-Type must be application/json
    Example: "application/json"

  - `Accept` (string, required)
    Accept must be application/json
    Example: "application/json"

## Path parameters:

  - `shopShipmentId` (string, required)
    Your ID for the Shipment

## Request fields (application/json):

  - `shop_shipment_event_id` (string, required)
    Your ID for the Shipment
    Example: "817391"

  - `status` (string, required)
    Enum: "label_printed", "label_purchased", "attempted_delivery", "ready_for_pickup", "carrier_picked_up", "confirmed", "in_transit", "out_for_delivery", "delivered", "delayed", "failure", "picked_up"

  - `message` (string)

  - `estimated_delivery_at` (string)
    Example: "2024-11-26T17:32:28Z"

  - `created_at` (string, required)
    When the event occurred in your e-comm platform
    Example: "2024-11-26T17:32:28Z"

## Response 201 fields (application/json):

  - `shop_shipment_event_id` (string, required)
    Your ID for the Shipment
    Example: "817391"

  - `status` (string, required)
    Enum: "label_printed", "label_purchased", "attempted_delivery", "ready_for_pickup", "carrier_picked_up", "confirmed", "in_transit", "out_for_delivery", "delivered", "delayed", "failure", "picked_up"

  - `message` (string)

  - `estimated_delivery_at` (string)
    Example: "2024-11-26T17:32:28Z"

  - `created_at` (string, required)
    When the event occurred in your e-comm platform
    Example: "2024-11-26T17:32:28Z"

## Response 422 fields (application/json):

  - `error` (array)
    Array of errors. Each error contains the field in the beginning followed by the issue found.
    Example: ["Name is required"]


## Response 404 fields

## Response 409 fields