A parcel has left

post/v1/orders/{id}/shipments

Request

  • Base URL: https://api.octapi.app
  • URL: https://api.octapi.app/v1/orders/{id}/shipments
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

carrierstring nullable
tracking_numberstring nullable
status'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed' | 'returned'
shipped_atstring date-time nullable
notestring nullable

Response

Default Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.