---
title: "PATCH /shipments/{shipmentID}"
method: PATCH
path: "/shipments/{shipmentID}"
tags: ["Shipment"]
---

# PATCH /shipments/{shipmentID}

`PATCH /shipments/{shipmentID}`

Updates a new shipment

## Path parameters

- `shipmentID` string, required

## Headers

- `Authorization` string, required

## Request body

- ShipmentPatch
  - `distanceUnit` string
  - `extraParcel` ShipmentUpdateExtraParcel[]
    - `distanceUnit` string
    - `height` CommonDbDecimal
      - `decimal.Decimal` number
    - `hidePackageContentOnTag` boolean
    - `length` CommonDbDecimal
      - `decimal.Decimal` number
    - `massUnit` string
    - `metadata` object
    - `parcelId` string
    - `parcelTemplateID` string
    - `productPaymentOnDelivery` boolean
    - `weight` CommonDbDecimal
      - `decimal.Decimal` number
    - `width` CommonDbDecimal
      - `decimal.Decimal` number
  - `height` CommonDbDecimal
    - `decimal.Decimal` number
  - `hidePackageContentOnTag` boolean
  - `isRecipientSMSActivated` boolean
  - `length` CommonDbDecimal
    - `decimal.Decimal` number
  - `massUnit` string
  - `merchantCode` string
  - `metadata` object
  - `order` Order
    - `buyerShipmentMethod` string
    - `buyerShippingCost` number
    - `buyerShippingCostCurrency` string
    - `createdAt` string
    - `id` string, uuid4
    - `itemIDs` string[]
    - `merchantCode` string
    - `notes` string
    - `orderCode` string
    - `orderNumber` string
    - `orderStatus` string — 1=order created 2=got offers 3=offer accepted 4=labels created
    - `organizationID` string, uuid4
    - `owner` string
    - `shipment` Shipment
      - `acceptedOffer` Offer
        - `amount` number
        - `amountLocal` number, float
        - `amountLocalOld` number, float
        - `amountLocalTax` number
        - `amountLocalVat` number, float
        - `amountOld` number, float
        - `amountTax` number
        - `amountVat` number
        - `averageEstimatedTime` integer
        - `averageEstimatedTimeHumanReadible` string
        - `bonusBalance` number
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `discountRate` number, float
        - `durationTerms` string
        - `estimatedArrivalTime` string
        - `id` string, uuid4
        - `integrationType` string
        - `isAccepted` boolean
        - `isC2C` boolean
        - `isGlobal` boolean
        - `isMainOffer` boolean
        - `maxEstimatedTime` integer
        - `minEstimatedTime` integer
        - `owner` string
        - `providerAccountID` string, uuid4
        - `providerCode` string
        - `providerServiceCode` string
        - `rating` number
        - `shipmentTime` string
        - `test` boolean
        - `totalAmount` number
        - `totalAmountLocal` number, float
        - `updatedAt` string
      - `acceptedOfferID` string, uuid4
      - `amount` number
      - `amountLocal` number, float
      - `amountLocalOld` number, float
      - `amountLocalTax` number
      - `amountLocalVat` number, float
      - `amountOld` number, float
      - `amountTax` number
      - `amountVat` number
      - `barcode` string
      - `bonusBalance` number
      - `buyerNote` string
      - `cancelDate` string — Duzelticelek
      - `categoryCode` string
      - `commercialInvoiceUrl` string
      - `createReturnLabel` boolean
      - `createdAt` string
      - `currency` string
      - `currencyLocal` string
      - `customsDeclaration` string
      - `desi` number — Desi of parcel
      - `discountRate` number, float
      - `distanceUnit` 'cm' — Distance unit of parcel
      - `enableAutomation` boolean
      - `eta` string
      - `extraParcels` Parcel[]
        - `amount` number
        - `amountLocal` number, float
        - `amountLocalOld` number, float
        - `amountLocalTax` number
        - `amountLocalVat` number, float
        - `amountOld` number, float
        - `amountTax` number
        - `amountVat` number
        - `barcode` string
        - `bonusBalance` number
        - `commercialInvoiceUrl` string
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `customsDeclaration` string
        - `desi` number — Desi of parcel
        - `discountRate` number, float
        - `distanceUnit` 'cm' — Distance unit of parcel
        - `eta` string
        - `extra` object
        - `height` number — Height of parcel
        - `hidePackageContentOnTag` boolean
        - `id` string, uuid4
        - `invoiceGenerated` boolean
        - `invoiceID` CommonDbUUID
          - `uuid.UUID` string
        - `isMainParcel` boolean
        - `itemIDs` string[]
        - `labelFileType` 'PDF' | 'JPG' | 'ZPLII' | 'ZPL'
        - `labelURL` string
        - `length` number — Length of parcel
        - `massUnit` 'kg' | 'lb' — Weight unit of parcel
        - `metadata` object — Meta data as JSON object to add additional info on your shipment/parcel
        - `metadataText` string — Meta string to add additional info on your shipment/parcel
        - `oldDesi` number
        - `oldWeight` number
        - `owner` string
        - `parcelReferenceCode` string
        - `parcelTemplateID` string, uuid4 — Instead of setting parcel size manually, you can set this to a predefined Parcel Template
        - `productPaymentOnDelivery` boolean
        - `qrCodeUrl` string
        - `refundInvoiceID` CommonDbUUID
          - `uuid.UUID` string
        - `responsiveLabelURL` string
        - `shipmentDate` string
        - `shipmentID` string, uuid4
        - `stateCode` string
        - `template` string
        - `test` boolean
        - `totalAmount` number
        - `totalAmountLocal` number, float
        - `trackingNumber` string — Tracking number
        - `trackingStatus` ModelsTracking
          - `createdAt` string
          - `hash` string
          - `id` string, uuid4
          - `locationName` string
          - `owner` string
          - `statusDate` string
          - `statusDetails` string
          - `test` boolean
          - `trackingStatusCode` string
          - `trackingSubStatusCode` string
          - `updatedAt` string
        - `trackingUrl` string
        - `updatedAt` string
        - `useDimensionsOfItems` boolean — If true, auto calculates total parcel size using the size of items
        - `useWeightOfItems` boolean — If true, auto calculates total parcel weight using the weight of items
        - `weight` number — Weight of parcel
        - `width` number — Width of parcel
      - `hasError` boolean
      - `height` number — Height of parcel
      - `hidePackageContentOnTag` boolean
      - `id` string, uuid4
      - `invoiceGenerated` boolean
      - `invoiceID` CommonDbUUID
        - `uuid.UUID` string
      - `isRecipientSmsActivated` boolean
      - `isReturn` boolean
      - `isReturned` boolean
      - `items` Item[]
        - `countryOfOrigin` string
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `id` string, uuid4
        - `massUnit` string
        - `maxDeliveryTime` string
        - `maxShipTime` string
        - `owner` string
        - `quantity` integer
        - `sku` string
        - `test` boolean
        - `title` string
        - `totalPrice` number
        - `totalPriceLocal` number
        - `unitPrice` number
        - `unitPriceLocal` number
        - `unitWeight` number
        - `updatedAt` string
        - `variantTitle` string
      - `labelFileType` 'PDF' | 'JPG' | 'ZPLII' | 'ZPL'
      - `labelURL` string
      - `lastErrorCode` string
      - `lastErrorMessage` string
      - `length` number — Length of parcel
      - `massUnit` 'kg' | 'lb' — Weight unit of parcel
      - `metadata` object — Meta data as JSON object to add additional info on your shipment/parcel
      - `metadataText` string — Meta string to add additional info on your shipment/parcel
      - `offers` OfferList
        - `allowOfferFallback` boolean
        - `cheapest` Offer
          - `amount` number
          - `amountLocal` number, float
          - `amountLocalOld` number, float
          - `amountLocalTax` number
          - `amountLocalVat` number, float
          - `amountOld` number, float
          - `amountTax` number
          - `amountVat` number
          - `averageEstimatedTime` integer
          - `averageEstimatedTimeHumanReadible` string
          - `bonusBalance` number
          - `createdAt` string
          - `currency` string
          - `currencyLocal` string
          - `discountRate` number, float
          - `durationTerms` string
          - `estimatedArrivalTime` string
          - `id` string, uuid4
          - `integrationType` string
          - `isAccepted` boolean
          - `isC2C` boolean
          - `isGlobal` boolean
          - `isMainOffer` boolean
          - `maxEstimatedTime` integer
          - `minEstimatedTime` integer
          - `owner` string
          - `providerAccountID` string, uuid4
          - `providerCode` string
          - `providerServiceCode` string
          - `rating` number
          - `shipmentTime` string
          - `test` boolean
          - `totalAmount` number
          - `totalAmountLocal` number, float
          - `updatedAt` string
        - `createdAt` string
        - `fastest` Offer
          - `amount` number
          - `amountLocal` number, float
          - `amountLocalOld` number, float
          - `amountLocalTax` number
          - `amountLocalVat` number, float
          - `amountOld` number, float
          - `amountTax` number
          - `amountVat` number
          - `averageEstimatedTime` integer
          - `averageEstimatedTimeHumanReadible` string
          - `bonusBalance` number
          - `createdAt` string
          - `currency` string
          - `currencyLocal` string
          - `discountRate` number, float
          - `durationTerms` string
          - `estimatedArrivalTime` string
          - `id` string, uuid4
          - `integrationType` string
          - `isAccepted` boolean
          - `isC2C` boolean
          - `isGlobal` boolean
          - `isMainOffer` boolean
          - `maxEstimatedTime` integer
          - `minEstimatedTime` integer
          - `owner` string
          - `providerAccountID` string, uuid4
          - `providerCode` string
          - `providerServiceCode` string
          - `rating` number
          - `shipmentTime` string
          - `test` boolean
          - `totalAmount` number
          - `totalAmountLocal` number, float
          - `updatedAt` string
        - `height` number
        - `itemIDs` string[]
        - `length` number
        - `list` Offer[]
          - `amount` number
          - `amountLocal` number, float
          - `amountLocalOld` number, float
          - `amountLocalTax` number
          - `amountLocalVat` number, float
          - `amountOld` number, float
          - `amountTax` number
          - `amountVat` number
          - `averageEstimatedTime` integer
          - `averageEstimatedTimeHumanReadible` string
          - `bonusBalance` number
          - `createdAt` string
          - `currency` string
          - `currencyLocal` string
          - `discountRate` number, float
          - `durationTerms` string
          - `estimatedArrivalTime` string
          - `id` string, uuid4
          - `integrationType` string
          - `isAccepted` boolean
          - `isC2C` boolean
          - `isGlobal` boolean
          - `isMainOffer` boolean
          - `maxEstimatedTime` integer
          - `minEstimatedTime` integer
          - `owner` string
          - `providerAccountID` string, uuid4
          - `providerCode` string
          - `providerServiceCode` string
          - `rating` number
          - `shipmentTime` string
          - `test` boolean
          - `totalAmount` number
          - `totalAmountLocal` number, float
          - `updatedAt` string
        - `owner` string
        - `parcelIDs` string[]
        - `parcelTemplateID` string, uuid4
        - `percentageCompleted` number
        - `providerAccountIDs` string[]
        - `providerCodes` string[]
        - `providerServiceCodes` string[]
        - `test` boolean
        - `totalOffersCompleted` integer
        - `totalOffersRequested` integer
        - `updatedAt` string
        - `weight` number
        - `width` number
      - `oldDesi` number
      - `oldWeight` number
      - `order` Order — recursive
      - `orderID` string, uuid4
      - `organizationShipmentID` integer
      - `owner` string
      - `parcelTemplateID` string, uuid4 — Instead of setting parcel size manually, you can set this to a predefined Parcel Template
      - `productPaymentOnDelivery` boolean
      - `providerAccountID` string, uuid4
      - `providerAccountIDs` string[]
      - `providerBranchName` string
      - `providerCode` string
      - `providerCodes` string[]
      - `providerInvoiceNo` string
      - `providerReceiptNo` string
      - `providerSerialNo` string
      - `providerServiceCode` string
      - `providerServiceCodes` string[]
      - `qrCodeUrl` string
      - `recipientAddress` Address
        - `address1` string
        - `address2` string
        - `city` City
          - `areaCode` string
          - `cityCode` string
          - `countryCode` string
          - `name` string — Model
        - `cityCode` string
        - `cityName` string
        - `countryCode` string
        - `countryName` string
        - `createdAt` string
        - `district` District
          - `cityCode` string
          - `countryCode` string
          - `districtID` integer
          - `name` string — Model
        - `districtID` integer — DistrictID *common.DbUUID `json:"districtID" ts_type:"string" swaggertype:"string" format:"uuid4" `
        - `districtName` string
        - `email` string
        - `id` string, uuid4
        - `isActive` boolean
        - `isDefaultReturnAddress` boolean
        - `isDefaultSenderAddress` boolean
        - `isInvoiceAddress` boolean
        - `isRecipientAddress` boolean
        - `metadata` object
        - `name` string
        - `owner` string
        - `phone` string
        - `shortName` string
        - `source` string
        - `state` string
        - `streetID` string, uuid4
        - `streetName` string
        - `test` boolean
        - `updatedAt` string
        - `zip` string
      - `recipientAddressID` string, uuid4
      - `refundInvoiceID` CommonDbUUID
        - `uuid.UUID` string
      - `responsiveLabelURL` string
      - `returnAddressID` string, uuid4
      - `sellerNote` string
      - `senderAddress` Address
        - `address1` string
        - `address2` string
        - `city` City
          - `areaCode` string
          - `cityCode` string
          - `countryCode` string
          - `name` string — Model
        - `cityCode` string
        - `cityName` string
        - `countryCode` string
        - `countryName` string
        - `createdAt` string
        - `district` District
          - `cityCode` string
          - `countryCode` string
          - `districtID` integer
          - `name` string — Model
        - `districtID` integer — DistrictID *common.DbUUID `json:"districtID" ts_type:"string" swaggertype:"string" format:"uuid4" `
        - `districtName` string
        - `email` string
        - `id` string, uuid4
        - `isActive` boolean
        - `isDefaultReturnAddress` boolean
        - `isDefaultSenderAddress` boolean
        - `isInvoiceAddress` boolean
        - `isRecipientAddress` boolean
        - `metadata` object
        - `name` string
        - `owner` string
        - `phone` string
        - `shortName` string
        - `source` string
        - `state` string
        - `streetID` string, uuid4
        - `streetName` string
        - `test` boolean
        - `updatedAt` string
        - `zip` string
      - `senderAddressID` string, uuid4, required
      - `shipmentDate` string
      - `statusCode` 'CREATED' | 'GOT_OFFERS' | 'OFFER_ACCEPTED' | 'TRACKING_CODE_CREATED' | 'LABEL_PRINTED' | 'SHIPPED' | 'DELIVERED' | 'CANCELED' | 'RETURNED' | 'RETURN_SHIPPED' | 'FAILED'
      - `tags` string[]
      - `test` boolean
      - `totalAmount` number
      - `totalAmountLocal` number, float
      - `trackingNumber` string — Tracking number
      - `trackingStatus` ModelsTracking
        - `createdAt` string
        - `hash` string
        - `id` string, uuid4
        - `locationName` string
        - `owner` string
        - `statusDate` string
        - `statusDetails` string
        - `test` boolean
        - `trackingStatusCode` string
        - `trackingSubStatusCode` string
        - `updatedAt` string
      - `trackingUrl` string
      - `updatedAt` string
      - `useDimensionsOfItems` boolean — If true, auto calculates total parcel size using the size of items
      - `useWeightOfItems` boolean — If true, auto calculates total parcel weight using the weight of items
      - `weight` number — Weight of parcel
      - `width` number — Width of parcel
    - `sourceCode` string
    - `sourceIdentifier` string
    - `test` boolean
    - `totalAmount` number
    - `totalAmountCurrency` string
    - `totalTax` number
    - `updatedAt` string
  - `parcelTemplateID` string
  - `productPaymentOnDelivery` boolean
  - `recipientAddress` Address
    - `address1` string
    - `address2` string
    - `city` City
      - `areaCode` string
      - `cityCode` string
      - `countryCode` string
      - `name` string — Model
    - `cityCode` string
    - `cityName` string
    - `countryCode` string
    - `countryName` string
    - `createdAt` string
    - `district` District
      - `cityCode` string
      - `countryCode` string
      - `districtID` integer
      - `name` string — Model
    - `districtID` integer — DistrictID *common.DbUUID `json:"districtID" ts_type:"string" swaggertype:"string" format:"uuid4" `
    - `districtName` string
    - `email` string
    - `id` string, uuid4
    - `isActive` boolean
    - `isDefaultReturnAddress` boolean
    - `isDefaultSenderAddress` boolean
    - `isInvoiceAddress` boolean
    - `isRecipientAddress` boolean
    - `metadata` object
    - `name` string
    - `owner` string
    - `phone` string
    - `shortName` string
    - `source` string
    - `state` string
    - `streetID` string, uuid4
    - `streetName` string
    - `test` boolean
    - `updatedAt` string
    - `zip` string
  - `weight` CommonDbDecimal
    - `decimal.Decimal` number
  - `width` CommonDbDecimal
    - `decimal.Decimal` number

## Response `200`

OK

- object
  - `additionalMessage` string
  - `code` string
  - `data` Shipment
    - `acceptedOffer` Offer
      - `amount` number
      - `amountLocal` number, float
      - `amountLocalOld` number, float
      - `amountLocalTax` number
      - `amountLocalVat` number, float
      - `amountOld` number, float
      - `amountTax` number
      - `amountVat` number
      - `averageEstimatedTime` integer
      - `averageEstimatedTimeHumanReadible` string
      - `bonusBalance` number
      - `createdAt` string
      - `currency` string
      - `currencyLocal` string
      - `discountRate` number, float
      - `durationTerms` string
      - `estimatedArrivalTime` string
      - `id` string, uuid4
      - `integrationType` string
      - `isAccepted` boolean
      - `isC2C` boolean
      - `isGlobal` boolean
      - `isMainOffer` boolean
      - `maxEstimatedTime` integer
      - `minEstimatedTime` integer
      - `owner` string
      - `providerAccountID` string, uuid4
      - `providerCode` string
      - `providerServiceCode` string
      - `rating` number
      - `shipmentTime` string
      - `test` boolean
      - `totalAmount` number
      - `totalAmountLocal` number, float
      - `updatedAt` string
    - `acceptedOfferID` string, uuid4
    - `amount` number
    - `amountLocal` number, float
    - `amountLocalOld` number, float
    - `amountLocalTax` number
    - `amountLocalVat` number, float
    - `amountOld` number, float
    - `amountTax` number
    - `amountVat` number
    - `barcode` string
    - `bonusBalance` number
    - `buyerNote` string
    - `cancelDate` string — Duzelticelek
    - `categoryCode` string
    - `commercialInvoiceUrl` string
    - `createReturnLabel` boolean
    - `createdAt` string
    - `currency` string
    - `currencyLocal` string
    - `customsDeclaration` string
    - `desi` number — Desi of parcel
    - `discountRate` number, float
    - `distanceUnit` 'cm' — Distance unit of parcel
    - `enableAutomation` boolean
    - `eta` string
    - `extraParcels` Parcel[]
      - `amount` number
      - `amountLocal` number, float
      - `amountLocalOld` number, float
      - `amountLocalTax` number
      - `amountLocalVat` number, float
      - `amountOld` number, float
      - `amountTax` number
      - `amountVat` number
      - `barcode` string
      - `bonusBalance` number
      - `commercialInvoiceUrl` string
      - `createdAt` string
      - `currency` string
      - `currencyLocal` string
      - `customsDeclaration` string
      - `desi` number — Desi of parcel
      - `discountRate` number, float
      - `distanceUnit` 'cm' — Distance unit of parcel
      - `eta` string
      - `extra` object
      - `height` number — Height of parcel
      - `hidePackageContentOnTag` boolean
      - `id` string, uuid4
      - `invoiceGenerated` boolean
      - `invoiceID` CommonDbUUID
        - `uuid.UUID` string
      - `isMainParcel` boolean
      - `itemIDs` string[]
      - `labelFileType` 'PDF' | 'JPG' | 'ZPLII' | 'ZPL'
      - `labelURL` string
      - `length` number — Length of parcel
      - `massUnit` 'kg' | 'lb' — Weight unit of parcel
      - `metadata` object — Meta data as JSON object to add additional info on your shipment/parcel
      - `metadataText` string — Meta string to add additional info on your shipment/parcel
      - `oldDesi` number
      - `oldWeight` number
      - `owner` string
      - `parcelReferenceCode` string
      - `parcelTemplateID` string, uuid4 — Instead of setting parcel size manually, you can set this to a predefined Parcel Template
      - `productPaymentOnDelivery` boolean
      - `qrCodeUrl` string
      - `refundInvoiceID` CommonDbUUID
        - `uuid.UUID` string
      - `responsiveLabelURL` string
      - `shipmentDate` string
      - `shipmentID` string, uuid4
      - `stateCode` string
      - `template` string
      - `test` boolean
      - `totalAmount` number
      - `totalAmountLocal` number, float
      - `trackingNumber` string — Tracking number
      - `trackingStatus` ModelsTracking
        - `createdAt` string
        - `hash` string
        - `id` string, uuid4
        - `locationName` string
        - `owner` string
        - `statusDate` string
        - `statusDetails` string
        - `test` boolean
        - `trackingStatusCode` string
        - `trackingSubStatusCode` string
        - `updatedAt` string
      - `trackingUrl` string
      - `updatedAt` string
      - `useDimensionsOfItems` boolean — If true, auto calculates total parcel size using the size of items
      - `useWeightOfItems` boolean — If true, auto calculates total parcel weight using the weight of items
      - `weight` number — Weight of parcel
      - `width` number — Width of parcel
    - `hasError` boolean
    - `height` number — Height of parcel
    - `hidePackageContentOnTag` boolean
    - `id` string, uuid4
    - `invoiceGenerated` boolean
    - `invoiceID` CommonDbUUID
      - `uuid.UUID` string
    - `isRecipientSmsActivated` boolean
    - `isReturn` boolean
    - `isReturned` boolean
    - `items` Item[]
      - `countryOfOrigin` string
      - `createdAt` string
      - `currency` string
      - `currencyLocal` string
      - `id` string, uuid4
      - `massUnit` string
      - `maxDeliveryTime` string
      - `maxShipTime` string
      - `owner` string
      - `quantity` integer
      - `sku` string
      - `test` boolean
      - `title` string
      - `totalPrice` number
      - `totalPriceLocal` number
      - `unitPrice` number
      - `unitPriceLocal` number
      - `unitWeight` number
      - `updatedAt` string
      - `variantTitle` string
    - `labelFileType` 'PDF' | 'JPG' | 'ZPLII' | 'ZPL'
    - `labelURL` string
    - `lastErrorCode` string
    - `lastErrorMessage` string
    - `length` number — Length of parcel
    - `massUnit` 'kg' | 'lb' — Weight unit of parcel
    - `metadata` object — Meta data as JSON object to add additional info on your shipment/parcel
    - `metadataText` string — Meta string to add additional info on your shipment/parcel
    - `offers` OfferList
      - `allowOfferFallback` boolean
      - `cheapest` Offer
        - `amount` number
        - `amountLocal` number, float
        - `amountLocalOld` number, float
        - `amountLocalTax` number
        - `amountLocalVat` number, float
        - `amountOld` number, float
        - `amountTax` number
        - `amountVat` number
        - `averageEstimatedTime` integer
        - `averageEstimatedTimeHumanReadible` string
        - `bonusBalance` number
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `discountRate` number, float
        - `durationTerms` string
        - `estimatedArrivalTime` string
        - `id` string, uuid4
        - `integrationType` string
        - `isAccepted` boolean
        - `isC2C` boolean
        - `isGlobal` boolean
        - `isMainOffer` boolean
        - `maxEstimatedTime` integer
        - `minEstimatedTime` integer
        - `owner` string
        - `providerAccountID` string, uuid4
        - `providerCode` string
        - `providerServiceCode` string
        - `rating` number
        - `shipmentTime` string
        - `test` boolean
        - `totalAmount` number
        - `totalAmountLocal` number, float
        - `updatedAt` string
      - `createdAt` string
      - `fastest` Offer
        - `amount` number
        - `amountLocal` number, float
        - `amountLocalOld` number, float
        - `amountLocalTax` number
        - `amountLocalVat` number, float
        - `amountOld` number, float
        - `amountTax` number
        - `amountVat` number
        - `averageEstimatedTime` integer
        - `averageEstimatedTimeHumanReadible` string
        - `bonusBalance` number
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `discountRate` number, float
        - `durationTerms` string
        - `estimatedArrivalTime` string
        - `id` string, uuid4
        - `integrationType` string
        - `isAccepted` boolean
        - `isC2C` boolean
        - `isGlobal` boolean
        - `isMainOffer` boolean
        - `maxEstimatedTime` integer
        - `minEstimatedTime` integer
        - `owner` string
        - `providerAccountID` string, uuid4
        - `providerCode` string
        - `providerServiceCode` string
        - `rating` number
        - `shipmentTime` string
        - `test` boolean
        - `totalAmount` number
        - `totalAmountLocal` number, float
        - `updatedAt` string
      - `height` number
      - `itemIDs` string[]
      - `length` number
      - `list` Offer[]
        - `amount` number
        - `amountLocal` number, float
        - `amountLocalOld` number, float
        - `amountLocalTax` number
        - `amountLocalVat` number, float
        - `amountOld` number, float
        - `amountTax` number
        - `amountVat` number
        - `averageEstimatedTime` integer
        - `averageEstimatedTimeHumanReadible` string
        - `bonusBalance` number
        - `createdAt` string
        - `currency` string
        - `currencyLocal` string
        - `discountRate` number, float
        - `durationTerms` string
        - `estimatedArrivalTime` string
        - `id` string, uuid4
        - `integrationType` string
        - `isAccepted` boolean
        - `isC2C` boolean
        - `isGlobal` boolean
        - `isMainOffer` boolean
        - `maxEstimatedTime` integer
        - `minEstimatedTime` integer
        - `owner` string
        - `providerAccountID` string, uuid4
        - `providerCode` string
        - `providerServiceCode` string
        - `rating` number
        - `shipmentTime` string
        - `test` boolean
        - `totalAmount` number
        - `totalAmountLocal` number, float
        - `updatedAt` string
      - `owner` string
      - `parcelIDs` string[]
      - `parcelTemplateID` string, uuid4
      - `percentageCompleted` number
      - `providerAccountIDs` string[]
      - `providerCodes` string[]
      - `providerServiceCodes` string[]
      - `test` boolean
      - `totalOffersCompleted` integer
      - `totalOffersRequested` integer
      - `updatedAt` string
      - `weight` number
      - `width` number
    - `oldDesi` number
    - `oldWeight` number
    - `order` Order
      - `buyerShipmentMethod` string
      - `buyerShippingCost` number
      - `buyerShippingCostCurrency` string
      - `createdAt` string
      - `id` string, uuid4
      - `itemIDs` string[]
      - `merchantCode` string
      - `notes` string
      - `orderCode` string
      - `orderNumber` string
      - `orderStatus` string — 1=order created 2=got offers 3=offer accepted 4=labels created
      - `organizationID` string, uuid4
      - `owner` string
      - `shipment` Shipment — recursive
      - `sourceCode` string
      - `sourceIdentifier` string
      - `test` boolean
      - `totalAmount` number
      - `totalAmountCurrency` string
      - `totalTax` number
      - `updatedAt` string
    - `orderID` string, uuid4
    - `organizationShipmentID` integer
    - `owner` string
    - `parcelTemplateID` string, uuid4 — Instead of setting parcel size manually, you can set this to a predefined Parcel Template
    - `productPaymentOnDelivery` boolean
    - `providerAccountID` string, uuid4
    - `providerAccountIDs` string[]
    - `providerBranchName` string
    - `providerCode` string
    - `providerCodes` string[]
    - `providerInvoiceNo` string
    - `providerReceiptNo` string
    - `providerSerialNo` string
    - `providerServiceCode` string
    - `providerServiceCodes` string[]
    - `qrCodeUrl` string
    - `recipientAddress` Address
      - `address1` string
      - `address2` string
      - `city` City
        - `areaCode` string
        - `cityCode` string
        - `countryCode` string
        - `name` string — Model
      - `cityCode` string
      - `cityName` string
      - `countryCode` string
      - `countryName` string
      - `createdAt` string
      - `district` District
        - `cityCode` string
        - `countryCode` string
        - `districtID` integer
        - `name` string — Model
      - `districtID` integer — DistrictID *common.DbUUID `json:"districtID" ts_type:"string" swaggertype:"string" format:"uuid4" `
      - `districtName` string
      - `email` string
      - `id` string, uuid4
      - `isActive` boolean
      - `isDefaultReturnAddress` boolean
      - `isDefaultSenderAddress` boolean
      - `isInvoiceAddress` boolean
      - `isRecipientAddress` boolean
      - `metadata` object
      - `name` string
      - `owner` string
      - `phone` string
      - `shortName` string
      - `source` string
      - `state` string
      - `streetID` string, uuid4
      - `streetName` string
      - `test` boolean
      - `updatedAt` string
      - `zip` string
    - `recipientAddressID` string, uuid4
    - `refundInvoiceID` CommonDbUUID
      - `uuid.UUID` string
    - `responsiveLabelURL` string
    - `returnAddressID` string, uuid4
    - `sellerNote` string
    - `senderAddress` Address
      - `address1` string
      - `address2` string
      - `city` City
        - `areaCode` string
        - `cityCode` string
        - `countryCode` string
        - `name` string — Model
      - `cityCode` string
      - `cityName` string
      - `countryCode` string
      - `countryName` string
      - `createdAt` string
      - `district` District
        - `cityCode` string
        - `countryCode` string
        - `districtID` integer
        - `name` string — Model
      - `districtID` integer — DistrictID *common.DbUUID `json:"districtID" ts_type:"string" swaggertype:"string" format:"uuid4" `
      - `districtName` string
      - `email` string
      - `id` string, uuid4
      - `isActive` boolean
      - `isDefaultReturnAddress` boolean
      - `isDefaultSenderAddress` boolean
      - `isInvoiceAddress` boolean
      - `isRecipientAddress` boolean
      - `metadata` object
      - `name` string
      - `owner` string
      - `phone` string
      - `shortName` string
      - `source` string
      - `state` string
      - `streetID` string, uuid4
      - `streetName` string
      - `test` boolean
      - `updatedAt` string
      - `zip` string
    - `senderAddressID` string, uuid4, required
    - `shipmentDate` string
    - `statusCode` 'CREATED' | 'GOT_OFFERS' | 'OFFER_ACCEPTED' | 'TRACKING_CODE_CREATED' | 'LABEL_PRINTED' | 'SHIPPED' | 'DELIVERED' | 'CANCELED' | 'RETURNED' | 'RETURN_SHIPPED' | 'FAILED'
    - `tags` string[]
    - `test` boolean
    - `totalAmount` number
    - `totalAmountLocal` number, float
    - `trackingNumber` string — Tracking number
    - `trackingStatus` ModelsTracking
      - `createdAt` string
      - `hash` string
      - `id` string, uuid4
      - `locationName` string
      - `owner` string
      - `statusDate` string
      - `statusDetails` string
      - `test` boolean
      - `trackingStatusCode` string
      - `trackingSubStatusCode` string
      - `updatedAt` string
    - `trackingUrl` string
    - `updatedAt` string
    - `useDimensionsOfItems` boolean — If true, auto calculates total parcel size using the size of items
    - `useWeightOfItems` boolean — If true, auto calculates total parcel weight using the weight of items
    - `weight` number — Weight of parcel
    - `width` number — Width of parcel
  - `message` string
  - `result` boolean

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `500` — Internal Server Error

---

[API](https://skmtc.dev/geliver/apis/geliver-api.md) · [All operations](https://skmtc.dev/geliver/apis/geliver-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/geliver/geliver-api/revisions/b477e23b5716/schema)