command

Create Shipment

Command to create a shipment with a carrier for a packed order.

Command
POST/shipments

Overview

CreateShipment is sent by the Carrier AdapterCarrier AdapterServicev1.0.0Translates Acme Inc shipment requests into the external carrier's format and sends them to create a shipment. Publishescreate-shipmentOwnerfulfilment-platformMapRepoView docs to the external CarrierCarrierSystemv1.0.0External carrier that delivers shipments to customers. It accepts shipment requests and reports delivery progress back. Ownerfulfilment-platformMapView docs to dispatch a packed order. The carrier responds asynchronously with Shipment CreatedShipment CreatedEventv1.0.0Published by the carrier when a shipment has been created and dispatched. Ownerfulfilment-platformSchemaMapView docs and later Shipment DeliveredShipment DeliveredEventv1.0.0Published by the carrier when a shipment has been delivered to the customer. Ownerfulfilment-platformSchemaMapView docs or Shipment FailedShipment FailedEventv1.0.0Published by the carrier when a shipment could not be delivered. Ownerfulfilment-platformSchemaMapView docs.

Architecture diagram

Schema

Event-driven architecture documentation: Acme Inc

JSON Schema

9 properties

Command to create a shipment with a carrier for a packed order

orderIdstring<uuid>
required
carrierstring

The carrier to ship with

servicestring
Allowed values: STANDARD EXPRESS NEXT_DAY
parcelCountinteger
Minimum: 1
destinationobject
required