Get by ID | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orgs.offChrtShipperOrg.getByIdV1("id");
}
main();

{
  "schema_version": 1,
  "email_address_primary": "email_address_primary",
  "created_by_org_id": "created_by_org_id",
  "created_by_user_id": "created_by_user_id",
  "_id": "_id",
  "company_name": "company_name",
  "industry": "industry",
  "street_address": {
    "type": "Feature",
    "geometry": {
      "type": "GeometryCollection",
      "geometries": [
        {
          "type": "LineString",
          "coordinates": [
            []
          ]
        }
      ]
    },
    "bbox": [
      {
        "key": "value"
      }
    ],
    "properties": {
      "address": "address",
      "name": "name"
    },
    "id": 1
  },
  "contact_first_name": "contact_first_name",
  "contact_last_name": "contact_last_name",
  "phone_number_primary": "phone_number_primary",
  "phone_number_secondary": "phone_number_secondary",
  "email_address_secondary": "email_address_secondary",
  "job_title": "job_title",
  "notes": "notes",
  "shipper_customer_id_for_stripe_connect_account": "shipper_customer_id_for_stripe_connect_account",
  "default_rate_sheet__routed": "default_rate_sheet__routed",
  "default_rate_sheet__on_demand": "default_rate_sheet__on_demand"
}

Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful Response

schema_versioninteger

email_address_primarystring

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

_idstring

company_namestring or null

industrystring or null

street_addressobject or null

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

contact_first_namestring or null

contact_last_namestring or null

phone_number_primarystring or null

phone_number_secondarystring or null

email_address_secondarystring or null

job_titlestring or null

notesstring or null

shipper_customer_id_for_stripe_connect_accountstring or null

default_rate_sheet__routedstring or null

default_rate_sheet__on_demandstring or null

Authentication

Path parameters

Response

Errors