Get the charges of a consignment

​
Path Parameters
  • consignmentId
    Type: stringFormat: uuid
    required
Responses
  • application/json
Request Example for get/v1/consignments/{consignmentId}/charges
curl https://api.consignlyhq.com/v1/consignments/123e4567-e89b-12d3-a456-426614174000/charges

{
  "clientActivityCharges": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isEffective": true,
      "particulars": null,
      "chargeTypeCode": null,
      "chargeTypeName": null,
      "metricValue": null,
      "chargeMin": null,
      "chargeBase": null,
      "chargeRate": null,
      "taxRatePercent": 1,
      "amountExclTax": 1
    }
  ],
  "clientFreightCharges": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "enum (ClientActivityAdhoc = 1, ClientActivityMetricRate = 2, ClientActivityProductRate = 3, ClientFreightAdhoc = 4, ClientFreightMetricRate = 5, ClientFreightProductRate = 6, CarrierFreightAdhoc = 7, CarrierFreightMetricRate = 8, CarrierFreightProductRate = 9)",
      "isEffective": true,
      "particulars": null,
      "metricValue": null,
      "chargeMin": null,
      "chargeBase": null,
      "chargeRate": null,
      "amountExclTax": 1
    }
  ],
  "carrierFreightCharges": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "enum (ClientActivityAdhoc = 1, ClientActivityMetricRate = 2, ClientActivityProductRate = 3, ClientFreightAdhoc = 4, ClientFreightMetricRate = 5, ClientFreightProductRate = 6, CarrierFreightAdhoc = 7, CarrierFreightMetricRate = 8, CarrierFreightProductRate = 9)",
      "isEffective": true,
      "particulars": null,
      "metricValue": null,
      "chargeMin": null,
      "chargeBase": null,
      "chargeRate": null,
      "amountExclTax": 1
    }
  ]
}

OK