CC-Transport API (1.0)

Download OpenAPI specification:Download

CC-Transport API - 1.0

Get a list of Consignment

Get a list of Consignment

query Parameters
status
string

missing description

Responses

200

OK

get /Consignments
/Consignments

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a new Consignment.

Create a new Consignment.

Request Body schema: application/json

Consignment

AssociatedInvoice
Array of string
AssociatedInvoiceDiscount
Array of string
AssociatedInvoiceDiscountPercent
Array of string
AvailabilityDue
Array of string
COD
string

The monetary value of the COD (Cash On Delivery) amount to be collected by the carrier upon delivery of this consignment.

CarrierAcceptance
Array of string
CarrierAssigned
string

The unique identifier assigned by the carrier to this consignment such as a booking reference number when cargo space is reserved prior to loading.

ChargeableTransportationStage
string

The quantity of separately chargeable transportation stages to be covered by this consignment.

ChargeableWeight
Array of string
ConsigneeAssigned
string

The unique identifier assigned by the consignee to this consignment.

ConsignmentItem
string

The number of consignment items separately defined for transport or customs purposes within this consignment.

ConsignorAssigned
string

The unique identifier assigned by the consignor to this consignment.

Containerization
string

The indication of whether or not this consignment is to be transported in a container or containers.

DeclaredValueForCarriage
string

The monetary value of this consignment as declared by the shipper or his agent for the purpose of varying the carrier's level of liability from that provided in the contract of carriage, in case of loss or damage to goods or delayed delivery.

DeclaredValueForCustoms
string

The monetary value declared for customs purposes for this consignment.

ExportExit
Array of string
FOB
string

The monetary value that has to be, or has been, paid for this consignment as calculated under FOB (Free on Board) delivery terms.

FreightForwarderAssigned
string

The unique identifier assigned by the freight forwarder to this consignment.

GoodsReleaseRestriction
Array of string
GrossVolume
Array of string
GrossWeight
Array of string
Identification
Array of string
IncludedConsignment
Array of object (Consignment)
IncludedConsignmentItems
object
Information
Array of string
InsurancePremium
Array of string
InsuranceValue
Array of string
LoadingLength
Array of string
LoadingList
string

The number of loading lists, manifests or similar documents for this consignment.

LoadingSequence
Array of string
NetVolume
Array of string
NetWeight
Array of string
NilCarriageValue
string

The indication of whether or not this consignment has a nil value for carriage.

NilCustomsValue
string

The indication of whether or not this consignment has a nil value for customs.

NilInsuranceValue
string

The indication of whether or not this consignment has a nil value for insurance.

Package
string

The number of packages within this consignment.

PackageType
Array of string
PaymentArrangement
string

The code specifying the payment arrangements for this consignment.

PlannedTransportMovement
Array of object (TransportMovement)
RiskFactor
Array of string
Sequence
Array of string
ShipStores
string

The indication of whether or not this consignment is for ship stores, such as for consumption on the means of transport.

SummaryDescription
Array of string
TotalAllowanceCharge
Array of string
TotalCharge
Array of string
TotalCollectCharge
Array of string
TotalDisbursement
Array of string
TotalExportExitToImportEntryCharge
Array of string
TotalPrepaidCharge
Array of string
TotalTareWeight
Array of string
TradedParcel
Array of string
TransportEquipment
Array of string
TransportEquipmentSplitGoods
string

The indication of whether or not the goods in this consignment are split across more than one piece of transport equipment.

TransportSplit
string

The indication of whether or not this consignment is split across different transport means or transport equipment.

TransportSplitDescription
Array of string
TransshipmentPermission
string

The indication of whether or not transshipment is permitted for this consignment.

UnloadingSequence
Array of string
WarehouseArrival
string

The date, time, date time, or other date time value of the arrival of this consignment at a warehouse.

Responses

201

Created

post /Consignments
/Consignments

Request samples

application/json
Copy
Expand all Collapse all
{
  • "AssociatedInvoice":
    [
    ],
  • "AssociatedInvoiceDiscount":
    [
    ],
  • "AssociatedInvoiceDiscountPercent":
    [
    ],
  • "AvailabilityDue":
    [
    ],
  • "COD": "string",
  • "CarrierAcceptance":
    [
    ],
  • "CarrierAssigned": "string",
  • "ChargeableTransportationStage": "string",
  • "ChargeableWeight":
    [
    ],
  • "ConsigneeAssigned": "string",
  • "ConsignmentItem": "string",
  • "ConsignorAssigned": "string",
  • "Containerization": "string",
  • "DeclaredValueForCarriage": "string",
  • "DeclaredValueForCustoms": "string",
  • "ExportExit":
    [
    ],
  • "FOB": "string",
  • "FreightForwarderAssigned": "string",
  • "GoodsReleaseRestriction":
    [
    ],
  • "GrossVolume":
    [
    ],
  • "GrossWeight":
    [
    ],
  • "Identification":
    [
    ],
  • "IncludedConsignment":
    [
    ],
  • "IncludedConsignmentItems":
    {