Detail by order ID

GET

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

GET

/shipping_integrations/alvys/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.alvys.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
}
main();

{
  "_id": "string",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "integration_order_id": "string",
  "mirrored_at_timestamp": "2024-01-15T09:30:00Z",
  "org_id": "string",
  "provider_org_id": "string",
  "provider_payload": {
    "CustomerId": "string",
    "Id": "string",
    "CancelledAt": "string",
    "CreatedAt": "string",
    "CustomerName": "string",
    "DeliveredAt": "string",
    "Destination": {
      "City": "string",
      "CompanyId": "string",
      "Coordinates": {
        "Latitude": "string",
        "Longitude": "string"
      },
      "Country": "string",
      "State": "string",
      "Street": "string",
      "ZipCode": "string"
    },
    "IsDeleted": true,
    "LoadNumber": "string",
    "OrderNumber": "string",
    "Origin": {
      "City": "string",
      "CompanyId": "string",
      "Coordinates": {
        "Latitude": "string",
        "Longitude": "string"
      },
      "Country": "string",
      "State": "string",
      "Street": "string",
      "ZipCode": "string"
    },
    "PONumber": "string",
    "PickedUpAt": "string",
    "Status": "string",
    "Stops": [
      {
        "Address": {
          "City": "string",
          "Country": "string",
          "State": "string",
          "Street": "string",
          "ZipCode": "string"
        },
        "AppointmentDate": "string",
        "ArrivedAt": "string",
        "CompanyName": "string",
        "Coordinates": {
          "Latitude": "string",
          "Longitude": "string"
        },
        "DepartedAt": "string",
        "Id": "string",
        "Status": "string",
        "StopType": "string"
      }
    ],
    "UpdatedAt": "string"
  },
  "provider_payload_hash": "string",
  "schema_version": 1,
  "shipping_integration": "string",
  "updated_at_timestamp": "2024-01-15T09:30:00Z"
}

Returns one mirrored Alvys load by the provider’s own load ID. | () -> (AlvysOrder1)

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

The Alvys load Id (32 hex), as carried on a unified order row

Response

Successful Response

_idstring

created_at_timestampstringformat: "date-time"

integration_order_idstring

mirrored_at_timestampstringformat: "date-time"

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 Alvys load, retaining all other fields.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"alvys"

updated_at_timestampstringformat: "date-time"

Errors

422

Unprocessable Entity Error