For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reconciliation Shipment Data

Every reconciliation record carries a shipment_data array describing the discrepancy per shipment. This section describes that object.

Attribute
Description

actual_weight

number

Weight the carrier recorded, in kg. Equal to declared_weight on an additional charge.

carrierName

string

Display name of the carrier that reported the discrepancy.

declared_weight

number

Weight declared at booking, in kg.

exception_charge

number

The difference being recovered for this shipment.

new_shipment_cost

number

What the shipment costs at the carrier's reported weight.

old_shipment_cost

number

What the shipment was originally charged.

platform

string

Carrier platform the discrepancy came from e.g. dhl, ups.

reconciliation_stage

enum

Point in the shipment's life the discrepancy was found. One of processing, delivery, invoice.

shipment_id

string

Unique reference for the shipment the discrepancy was raised against.

shipment_number

string

Carrier tracking number for the shipment.

tracking_only

boolean

Indicates the discrepancy is recorded for tracking only and will not be billed.

Was this helpful?