Retrieve CHAMP confirmation receipts

GET

/integrations/air_waybills/confirmations/v1/:task_group_id

GET

/integrations/air_waybills/confirmations/v1/:task_group_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.integrations.airWaybills.confirmationsV1("task_group_id");
}
main();

[
  {
    "_id": "string",
    "airWaybillNumber": "string",
    "champId": "string",
    "destination": "string",
    "messageHeader": {
      "addressing": {
        "finalRecipientAddresses": [
          {
            "address": "string",
            "type": "PIMA"
          }
        ],
        "replyAnswerTo": [
          {
            "address": "string",
            "type": "PIMA"
          }
        ],
        "routeAnswerVia": {
          "address": "string",
          "type": "PIMA"
        },
        "routeVia": {
          "address": "string",
          "type": "PIMA"
        },
        "senderAddresses": [
          {
            "address": "string",
            "type": "PIMA"
          }
        ]
      },
      "creationDate": "2024-01-15T09:30:00Z",
      "edifactData": {
        "commonAccessReference": "string",
        "interchangeControlReference": "string",
        "messageReference": "string",
        "password": "string"
      }
    },
    "origin": "string",
    "receivedAt": "2024-01-15T09:30:00Z",
    "referencedMessageType": "string",
    "rejected": true,
    "textMessage": "string",
    "type": "string",
    "orgId": "string",
    "referenceMessageContent": "string",
    "schemaVersion": 1,
    "taskGroupId": "string"
  }
]

Retrieves all CHAMP confirmation receipts linked to the air waybill for a task group. | () -> (list[ChampConfirmationReceipt1])

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

_idstring

airWaybillNumberstring

champIdstring

destinationstring

messageHeaderobject

[GENERATED/CONFIG] Message header with addressing and creation timestamp.

originstring

receivedAtstringformat: "date-time"

referencedMessageTypestring

rejectedboolean

textMessagestring

type"confirmation receipt"

orgIdstring or nullOptional

referenceMessageContentstring or nullOptional

schemaVersionintegerOptionalDefaults to 1

taskGroupIdstring or nullOptional

Errors

422

Unprocessable Entity Error