Order and shipment information

POST /openapi/Consignment/GetConsignmentInfo — TMS API · Tracking and Status

Returns shipments of orders with carrier, tracking number/link, volume, delivery type, price, estimated delivery dates, package information, final status, and full status history.

• If orders[].consignments is left empty, all shipments of the order are returned.
• Status codes (statusCode) come from the TMS status table; e.g. NOTSTARTED, PRINTEDBARCODELABEL, WAITDELIVERY, INTRANSIT, ENROUTE, DELIVERED, RETURNED.
• carrierStatusCode / carrierStatus are the carrier's own status code and description.

İstek gövdesi

• orders (object[], zorunlu): Orders to query.
  • orders.orderNumber (string): Order number.
  • orders.consignments (object[]): Return only these shipments; if empty, all shipments of the order are returned.
• clientCode (string, zorunlu): Organization code.
• accountCode (string, zorunlu): Account code.

Yanıtlar

• 200: Shipment information per order
• 400: Validation error
• 401: Token missing, invalid, or expired (response without body).

200 yanıt alanları

• orderNumber (string): Order number.
• consignments (object[]): Shipments of the order.
  • consignments.carrier (string): Carrier name.
  • consignments.otpCode (string): Pickup code for delivery point shipments.
  • consignments.shipments (object[]): Carrier shipments linked to the shipment.
    • consignments.shipments.price (number): Customer price.
    • consignments.shipments.carrier (string): Carrier name.
    • consignments.shipments.parcels (object[]): Packages.
    • consignments.shipments.lastStatus (object)
    • consignments.shipments.returnCode (string): Return code (for return shipments).
    • consignments.shipments.carrierCode (string): Carrier code.
    • consignments.shipments.carrierCost (number): Carrier cost.
    • consignments.shipments.deliveryType (string): Delivery type name.
    • consignments.shipments.locationCode (string): Origin location code.
    • consignments.shipments.trackingLink (string): Tracking link.
    • consignments.shipments.trackingNumber (string): Tracking number.
    • consignments.shipments.statusHistories (object[]): Status history (oldest to newest).
    • consignments.shipments.deliveryDuration (integer): Estimated delivery time (days).
    • consignments.shipments.deliverySlotType (string): Delivery time slot name.
    • consignments.shipments.deliveryTypeCode (string): Delivery type code.
    • consignments.shipments.volumetricWeight (number): Declared volume.
    • consignments.shipments.deliverySlotTypeCode (string): Delivery time slot code.
    • consignments.shipments.estimatedDeliveryTime (string<date-time>): Estimated delivery date.
    • consignments.shipments.estimatedShippingTime (string<date-time>): Estimated shipment date.
    • consignments.shipments.carrierVolumetricWeight (number): Carrier measured volume.
  • consignments.carrierCode (string): Carrier code.
  • consignments.locationCode (string): Origin location code.
  • consignments.consignmentNumber (string): Shipment number.
  • consignments.consignmentStatus (object)
    • consignments.consignmentStatus.status (string): TMS status description.
    • consignments.consignmentStatus.statusCode (string): TMS status code.
    • consignments.consignmentStatus.statusDate (string<date-time>): Status timestamp.
    • consignments.consignmentStatus.carrierStatus (string): Carrier's status description.
    • consignments.consignmentStatus.carrierStatusCode (string): Carrier's status code.
• errorMessage (string): Error message per order.
• customizedTrackingLink (string): Tracking page link specific to your account.