Detail

GET

/shipping_integrations/ecourier/creds/detail/v1/:provider_org_id

GET

/shipping_integrations/ecourier/creds/detail/v1/:provider_org_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shippingIntegrations.ecourier.creds.detailV1("provider_org_id");
}
main();

{
  "_id": "_id",
  "base_url": "https://bigtex.e-courier.com",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "ecourier_customer_code": "ecourier_customer_code",
  "ecourier_customer_id": "ecourier_customer_id",
  "ecourier_database": "ecourier_database",
  "org_id": "org_id",
  "owned_by_user_id": "owned_by_user_id",
  "provider_org_id": "provider_org_id",
  "schema_version": 1,
  "shipping_integration": "ecourier",
  "updated_at_timestamp": "2024-01-15T09:30:00Z",
  "username": "username",
  "active": true,
  "high_water_mark_timestamp": "2024-01-15T09:30:00Z",
  "notes": "notes",
  "provider_account_label": "provider_account_label"
}

Returns the caller’s e-Courier credential for one provider, without the password or session token. | () -> (EcourierCredsLimited1)

Authentication

AuthorizationBearer

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

Path parameters

provider_org_idstringRequired

Must be a string starting with org_

Response

Successful Response

_idstring

base_urlstring

Origin of the courier’s e-Courier host, with no path. The request path is derived from ecourier_database.

created_at_timestampdatetime

ecourier_customer_codestringformat: "^[A-Za-z0-9_-]{1,32}$"

ecourier_customer_idstringformat: "^[A-Za-z0-9_-]{1,32}$"

ecourier_databasestringformat: "^[a-z0-9_-]{1,64}$"

org_idstring

Must be a string starting with org_

owned_by_user_idstring

Must be a string starting with user_

provider_org_idstring

Must be a string starting with org_

schema_versioninteger

shipping_integration"ecourier"

updated_at_timestampdatetime

usernamestring

activebooleanOptionalDefaults to true

high_water_mark_timestampdatetimeOptional

notesstringOptional<=4096 characters

provider_account_labelstringOptional<=2048 characters

Errors

422

Creds Detail V1request Unprocessable Entity Error