Price Item (CI, Outbound)

Price item contains data about surcharge requests that have been accepted by the shipper.

Field Description

Field

Description

Mandatory

Remark

Field

Description

Mandatory

Remark

id

Price item identifier

True

 

document_reference

Reference number for this document / message.

True

This is a unique reference per transaction on our side.

It can be used as a reference for our support teams.

Note, it is not unique if a transaction on our side generated multiple messages.

transport_id

Unique Transport ID reference

True

 

carrier_id

Carrier customer number

True

 

shipper_id

Shipper customer number

True

 

category

Category

False

 

qualifier

Price item qualifier

True

Qualifiers are shipper specific and highly depend on individual processes

status

Price item status

True

Status

  • Accepted: Surcharge has been accepted

  • Declined: Surcharge has been declined

price

Price amount

True

 

currency_id

Currency code

True

 According to ISO 4217

description

Description

False

 

datetime

Date and time of last change

True

 System timestamp

parameters

Customer specific additional fields

See Parameter (CI)

False

 



Â