/shipping_integrations

Detail

Returns one unified shipping integration order by its Mongo ObjectId with related organizations expanded. | () -> (ShippingIntegrationOrderExpanded1)

get/shipping_integrations/orders/detail/v1/{id}

Path parameters

idstring required

Mongo ObjectId of the unified order document. The provider's own order ID is the integration_order_id field on the returned order.

Successful Response

schema_version1 required

_idstring required

org_idstring required

Must be a string starting with org_

provider_org_idstring required

Must be a string starting with org_

integration_order_idstring required

reference_numbersstring[]

status'staged' | 'in_progress' | 'completed' | 'cancelled' | 'exception' required

provider_status_rawstring nullable

originShippingIntegrationOrderPlace1 — unresolved $ref

destinationShippingIntegrationOrderPlace1 — unresolved $ref

stop_countinteger nullable

ordered_at_timestampstring date-time nullable

in_progress_at_timestampstring date-time nullable

in_progress_at_provenance'reported' | 'derived'

completed_at_timestampstring date-time nullable

completed_at_provenance'reported' | 'derived'

source_provider_payload_hashstring required

first_mirrored_at_timestampstring date-time required

last_mirrored_at_timestampstring date-time required

provider_orgOrgPublicData1 — unresolved $ref

shipper_orgOrgPublicData1 — unresolved $ref

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