CHchrt
/shipping_integrations

Detail

Changed on

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

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

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping_integrations/orders/detail/v1/{id}
  • Auth
    HTTP bearer

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.

Response

Successful Response

schema_version1 required
_idstring required
org_idstring required

Must be a string starting with org_

shipping_integration'xcelerator' | 'dispatch_science' | 'ontime360' | 'cxt' | 'atlas' | 'ecourier' | 'courie' required
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
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

Changes

  • 5e62049a1c19Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 9a30893d8db1Revision changes
    • warning

      added the new courie enum value to the response property for the response status