Detail by order ID

GET

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

GET

/shipping_integrations/xcelerator/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.xcelerator.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": {
    "OrderTrackingId": "OrderTrackingId",
    "AccountNo": "AccountNo",
    "AfterHoursCharge": 1.1,
    "CODCharge": 1.1,
    "ClientRefNo": "ClientRefNo",
    "ClientRefNo2": "ClientRefNo2",
    "ClientRefNo3": "ClientRefNo3",
    "ClientRefNo4": "ClientRefNo4",
    "CreationUTC": "CreationUTC",
    "DCity": "DCity",
    "DCoName": "DCoName",
    "DContact": "DContact",
    "DLatitude": 1.1,
    "DLongitude": 1.1,
    "DState": "DState",
    "DStreet": "DStreet",
    "DStreet2": "DStreet2",
    "DTimeZoneText": "DTimeZoneText",
    "DZip": "DZip",
    "DeclaredValueCharge": 1.1,
    "DeliveryArrival": "DeliveryArrival",
    "DeliveryDeparture": "DeliveryDeparture",
    "DeliveryTargetFrom": "DeliveryTargetFrom",
    "DeliveryTargetTo": "DeliveryTargetTo",
    "GrandTotal": 1.1,
    "HasPODsignature": true,
    "HasPOPsignature": true,
    "HasVPOD": true,
    "HasVPOP": true,
    "HourlyCharge": 1.1,
    "MileageTotal": 1.1,
    "MiscCharge": 1.1,
    "OrderCharge": 1.1,
    "OrderExtras": [
      {}
    ],
    "OrderPackages": [
      {}
    ],
    "OrderType": "OrderType",
    "PCity": "PCity",
    "PCoName": "PCoName",
    "PContact": "PContact",
    "PLatitude": 1.1,
    "PLongitude": 1.1,
    "PODcompletion": "PODcompletion",
    "PODname": "PODname",
    "POPname": "POPname",
    "PState": "PState",
    "PStreet": "PStreet",
    "PStreet2": "PStreet2",
    "PTimeZoneText": "PTimeZoneText",
    "PZip": "PZip",
    "PackageCharge": 1.1,
    "PickupArrival": "PickupArrival",
    "PickupDeparture": "PickupDeparture",
    "PickupTargetFrom": "PickupTargetFrom",
    "PickupTargetTo": "PickupTargetTo",
    "ServiceName": "ServiceName",
    "Status": "Status",
    "StopOffCharge": 1.1,
    "Subtotal": 1.1,
    "Tax1Amount": 1.1,
    "Tax2Amount": 1.1,
    "TollCharge": 1.1,
    "TotalCharge": 1.1,
    "TotalExtras": 1.1,
    "TotalSurcharges": 1.1,
    "TrackingKey": "TrackingKey",
    "VehicleName": "VehicleName",
    "WaitTimeCharge": 1.1,
    "WarehousingCharge": 1.1,
    "WeightCharge": 1.1,
    "oDate": "oDate",
    "sWeight": 1.1
  },
  "provider_payload_hash": "provider_payload_hash",
  "schema_version": 1,
  "shipping_integration": "xcelerator",
  "updated_at_timestamp": "2024-01-15T09:30:00Z",
  "provider_org": {
    "_id": "_id",
    "name": "name",
    "org_id": "org_id",
    "org_type": "provider",
    "schema_version": 1,
    "description": "description",
    "email_address": "email_address",
    "handle": "handle",
    "industry": "industry",
    "phone_number": "phone_number",
    "street_address": {
      "geometry": {
        "type": "GeometryCollection",
        "geometries": [
          {
            "type": "LineString",
            "coordinates": [
              []
            ]
          }
        ]
      },
      "type": "Feature",
      "id": 1
    }
  }
}

Returns one mirrored Xcelerator order by the provider’s own order ID with the provider organization expanded. | () -> (XceleratorOrderExpanded1)

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

Xcelerator’s own ID for the order (its OrderTrackingId), 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

Known fields from an Axis v3 or v4 order, retaining all other fields.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"xcelerator"

updated_at_timestampdatetime

provider_orgobjectOptional

Errors

422

Orders Detail by Integration Order ID V1request Unprocessable Entity Error