Skip to main content

Shipment

Base path: /api/data/shipment

All shipment CRUD endpoints are registered but not yet implemented — handlers are empty stubs.

POST /api/data/shipment

Create a new shipment record.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.

Shipment Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
orderIdstringYesAssociated order ID
carrierstringNoShipping carrier name
servicestringNoShipping service level
trackingNumberstringNoTracking number
labelUrlstringNoShipping label URL (must be valid URL)
statusenumNoPENDING (default), LABEL_CREATED, SHIPPED, DELIVERED, FAILED
shipFromobjectNoOrigin address (see Address schema)
shipToobjectNoDestination address (see Address schema)
shippedAtdateNoShipment date
deliveredAtdateNoDelivery date
createdAtdateYesCreation timestamp
updatedAtdateYesLast update timestamp

Address object (used by shipFrom and shipTo):

FieldTypeRequiredDescription
namestringYesRecipient name
line1stringYesStreet address line 1
line2stringNoStreet address line 2
citystringYesCity
statestringYesState / province
postalCodestringYesZIP / postal code
countrystringYesCountry code (min 2 chars)
phonestringNoPhone number

GET /api/data/shipment/:id

Retrieve a shipment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


PATCH /api/data/shipment/:id

Update a shipment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


DELETE /api/data/shipment/:id

Delete a shipment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.