Shipment

Fetch shipment

get/shipments/{shipmentID}

Path parameters

shipmentIDstring required

ID of shipment as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)

Headers

Authorizationstring required

Bearer Token (Example: Bearer foo)

Response

OK

additionalMessagestring
codestring
messagestring
resultboolean

Example response

{
  "data": {
    "acceptedOffer": {
      "amount": 17.5,
      "amountLocal": 17.5,
      "amountLocalOld": 17.5,
      "amountLocalTax": 17.5,
      "amountLocalVat": 17.5,
      "amountOld": 17.5,
      "amountTax": 17.5,
      "amountVat": 17.5,
      "bonusBalance": 17.5,
      "currency": "TL",
      "currencyLocal": "TL",
      "discountRate": 17.5,
      "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
      "totalAmount": 17.5,
      "totalAmountLocal": 17.5
    },
    "amount": 17.5,
    "amountLocal": 17.5,
    "amountLocalOld": 17.5,
    "amountLocalTax": 17.5,
    "amountLocalVat": 17.5,
    "amountOld": 17.5,
    "amountTax": 17.5,
    "amountVat": 17.5,
    "bonusBalance": 17.5,
    "currency": "TL",
    "currencyLocal": "TL",
    "desi": 1,
    "discountRate": 17.5,
    "extraParcels": [
      {
        "amount": 17.5,
        "amountLocal": 17.5,
        "amountLocalOld": 17.5,
        "amountLocalTax": 17.5,
        "amountLocalVat": 17.5,
        "amountOld": 17.5,
        "amountTax": 17.5,
        "amountVat": 17.5,
        "bonusBalance": 17.5,
        "currency": "TL",
        "currencyLocal": "TL",
        "desi": 1,
        "discountRate": 17.5,
        "height": 1,
        "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
        "labelFileType": "PDF",
        "length": 1,
        "oldDesi": 1,
        "oldWeight": 1,
        "parcelTemplateID": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
        "totalAmount": 17.5,
        "totalAmountLocal": 17.5,
        "trackingStatus": {
          "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb"
        },
        "weight": 1,
        "width": 1
      }
    ],
    "height": 1,
    "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
    "items": [
      {
        "currency": "TL",
        "currencyLocal": "TL",
        "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
        "unitPriceLocal": 20,
        "unitWeight": 1
      }
    ],
    "labelFileType": "PDF",
    "length": 1,
    "offers": {
      "cheapest": {
        "amount": 17.5,
        "amountLocal": 17.5,
        "amountLocalOld": 17.5,
        "amountLocalTax": 17.5,
        "amountLocalVat": 17.5,
        "amountOld": 17.5,
        "amountTax": 17.5,
        "amountVat": 17.5,
        "bonusBalance": 17.5,
        "currency": "TL",
        "currencyLocal": "TL",
        "discountRate": 17.5,
        "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
        "totalAmount": 17.5,
        "totalAmountLocal": 17.5
      },
      "fastest": {
        "amount": 17.5,
        "amountLocal": 17.5,
        "amountLocalOld": 17.5,
        "amountLocalTax": 17.5,
        "amountLocalVat": 17.5,
        "amountOld": 17.5,
        "amountTax": 17.5,
        "amountVat": 17.5,
        "bonusBalance": 17.5,
        "currency": "TL",
        "currencyLocal": "TL",
        "discountRate": 17.5,
        "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
        "totalAmount": 17.5,
        "totalAmountLocal": 17.5
      },
      "height": 1,
      "length": 1,
      "list": [
        {
          "amount": 17.5,
          "amountLocal": 17.5,
          "amountLocalOld": 17.5,
          "amountLocalTax": 17.5,
          "amountLocalVat": 17.5,
          "amountOld": 17.5,
          "amountTax": 17.5,
          "amountVat": 17.5,
          "bonusBalance": 17.5,
          "currency": "TL",
          "currencyLocal": "TL",
          "discountRate": 17.5,
          "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
          "totalAmount": 17.5,
          "totalAmountLocal": 17.5
        }
      ],
      "weight": 1,
      "width": 1
    },
    "oldDesi": 1,
    "oldWeight": 1,
    "order": {
      "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb"
    },
    "parcelTemplateID": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb",
    "recipientAddress": {
      "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb"
    },
    "senderAddress": {
      "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb"
    },
    "totalAmount": 17.5,
    "totalAmountLocal": 17.5,
    "trackingStatus": {
      "id": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb"
    },
    "weight": 1,
    "width": 1
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.