Detail by order ID

GET

/shipping_integrations/courie/orders/by_integration_order_id/detail/v1/:org_id/:integration_order_id

GET

/shipping_integrations/courie/orders/by_integration_order_id/detail/v1/:org_id/:integration_order_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shippingIntegrations.courie.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
}
main();

{
  "_id": "_id",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "integration_order_id": "integration_order_id",
  "mirrored_at_timestamp": "2024-01-15T09:30:00Z",
  "org_id": "org_id",
  "provider_org_id": "provider_org_id",
  "provider_payload": {
    "customerId": "customerId",
    "id": "id",
    "status": "CREATED",
    "activities": [
      {
        "event": "CREATED",
        "timestamp": "2024-01-15T09:30:00Z"
      }
    ],
    "customFields": [
      {}
    ],
    "customerCompanyName": "customerCompanyName",
    "deliveredAt": "2024-01-15T09:30:00Z",
    "displayId": 1,
    "numPackages": 1,
    "packageDescription": "packageDescription",
    "packageItems": [
      {}
    ],
    "packageSize": "packageSize",
    "packageTypeName": "packageTypeName",
    "packageWeightInPounds": 1.1,
    "packages": [
      {}
    ],
    "pickedUpAt": "2024-01-15T09:30:00Z",
    "proofOfDeliveries": [
      {}
    ],
    "proofOfPickUps": [
      {}
    ],
    "referenceNumber": "referenceNumber",
    "remoteId": "remoteId",
    "serviceTypeName": "serviceTypeName",
    "shipmentDate": "shipmentDate",
    "shipmentType": "shipmentType",
    "statusDescription": "statusDescription",
    "stops": [
      {
        "type": "PICK_UP"
      }
    ],
    "trackingNumber": "trackingNumber",
    "trackingUrl": "trackingUrl",
    "vehicleTypeName": "vehicleTypeName"
  },
  "provider_payload_hash": "provider_payload_hash",
  "schema_version": 1,
  "shipping_integration": "courie",
  "updated_at_timestamp": "2024-01-15T09:30:00Z"
}

Returns one mirrored Courie order by the provider’s own order ID. | () -> (CourieOrder1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

org_idstringRequired

CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)

integration_order_idstringRequired

Courie's own ID for the order, as carried on a unified order row

Response

Successful Response

_idstring

created_at_timestampdatetime

integration_order_idstring

mirrored_at_timestampdatetime

org_idstring

Must be a string starting with org_

provider_org_idstring

Must be a string starting with org_

provider_payloadobject

One Courie order, as returned by both the list and detail endpoints.

The list endpoint returns this same complete shape, so the mirror never needs a per-order detail call.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"courie"

updated_at_timestampdatetime

Errors

422

Orders Detail by Integration Order ID V1request Unprocessable Entity Error