Shipment Visibility API

Before you begin

You need EDRAY approval and an APIM subscription key for production shipment creation. Use the endpoint and identifier mappings supplied during onboarding. The agreed contract may be tailored to your integration.

The example uses fictional data and api.example.invalid, a non-routable .invalid host. Replace the sample IDs with values approved by EDRAY for your integration.

What you send us

Send one shipment object to POST /prod/shipment. The production schema requires shipperId, containerTypeId, containerNumber, isCancelled, isActive, and shipmentCreated. These are documented schema requirements; their runtime validation has not been verified.

curl --request POST https://api.example.invalid/prod/shipment \
  --header "Ocp-Apim-Subscription-Key: $APIM_SUBSCRIPTION_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "shipperId": 1,
    "containerTypeId": 1,
    "containerNumber": "EDRU1234567",
    "isCancelled": false,
    "isActive": true,
    "shipmentCreated": "2026-09-16T12:00:00Z",
    "masterBillOfLading": "EXAMPLE-MBL-001",
    "customerReferenceNumber": "SHP-EXAMPLE-001"
  }'

What you get back

The production definition documents HTTP 201 with a Shipment body. The configured route queues the request and passes through the backend response without a standard acceptance envelope. The actual HTTP status and body have not been verified by a transaction.

A queue acknowledgement does not confirm that a shipment was created. Agree on how completed processing is confirmed before integrating.

Receive milestones

Ocean terminal and rail milestone delivery is integration-specific. During onboarding, agree on the fields, reference mapping, delivery method, authentication, and retry behavior. Verify that delivery works with your receiving system in the agreed validation session.

The production milestone retrieval definition contains an events array of MilestoneOB objects, with fields such as EventName, EventDate, ContainerNumber, MasterBillOfLading, and CustomerReference. This retrieval format is not a standard customer webhook payload; use the delivery contract agreed for your integration.

Errors and support

The inspected production creation policy does not define a common error body or field-level validation response. Handle the HTTP status and response returned by the backend; do not depend on a fixed JSON error format. Retain request time, shipment references, and response details for support, excluding credentials.

Failures after acceptance are not returned by the original request. Agree on how processing failures are reported and resolved during onboarding. Confirm retry and duplicate-handling behavior before resubmitting a shipment.