Sign in
Shipment

Creates a new shipment

post/shipments

Headers

Authorizationstring required

Bearer Token (Example: Bearer foo)

Request body

acceptedOfferIDstring uuid4
amountnumber
amountLocalnumber float
amountLocalOldnumber float
amountLocalTaxnumber
amountLocalVatnumber float
amountOldnumber float
amountTaxnumber
amountVatnumber
barcodestring
bonusBalancenumber
buyerNotestring
cancelDatestring

Duzelticelek

categoryCodestring
commercialInvoiceUrlstring
createReturnLabelboolean
createdAtstring
currencystring
currencyLocalstring
customsDeclarationstring
desinumber

Desi of parcel

discountRatenumber float
distanceUnit'cm'

Distance unit of parcel

enableAutomationboolean
etastring
hasErrorboolean
heightnumber

Height of parcel

hidePackageContentOnTagboolean
idstring uuid4
invoiceGeneratedboolean
isRecipientSmsActivatedboolean
isReturnboolean
isReturnedboolean
labelFileType'PDF' | 'JPG' | 'ZPLII' | 'ZPL'
labelURLstring
lastErrorCodestring
lastErrorMessagestring
lengthnumber

Length of parcel

massUnit'kg' | 'lb'

Weight unit of parcel

metadataobject

Meta data as JSON object to add additional info on your shipment/parcel

metadataTextstring

Meta string to add additional info on your shipment/parcel

oldDesinumber
oldWeightnumber
orderIDstring uuid4
organizationShipmentIDinteger
ownerstring
parcelTemplateIDstring uuid4

Instead of setting parcel size manually, you can set this to a predefined Parcel Template

productPaymentOnDeliveryboolean
providerAccountIDstring uuid4
providerAccountIDsstring[]
providerBranchNamestring
providerCodestring
providerCodesstring[]
providerInvoiceNostring
providerReceiptNostring
providerSerialNostring
providerServiceCodestring
providerServiceCodesstring[]
qrCodeUrlstring
recipientAddressIDstring uuid4
responsiveLabelURLstring
returnAddressIDstring uuid4
sellerNotestring
senderAddressIDstring uuid4 required
shipmentDatestring
statusCode'CREATED' | 'GOT_OFFERS' | 'OFFER_ACCEPTED' | 'TRACKING_CODE_CREATED' | 'LABEL_PRINTED' | 'SHIPPED' | 'DELIVERED' | 'CANCELED' | 'RETURNED' | 'RETURN_SHIPPED' | 'FAILED'
tagsstring[]
testboolean
totalAmountnumber
totalAmountLocalnumber float
trackingNumberstring

Tracking number

trackingUrlstring
updatedAtstring
useDimensionsOfItemsboolean

If true, auto calculates total parcel size using the size of items

useWeightOfItemsboolean

If true, auto calculates total parcel weight using the weight of items

weightnumber

Weight of parcel

widthnumber

Width of parcel

Example request

{
  "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
}

Response

Created

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",
      "shipment": {
        "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,
        "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
      }
    },
    "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,
    "extra": {
      "insurance": {
        "currency": "TL"
      }
    }
  }
}

Changes

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