Shipment

the shipment API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get

/vds/shipment/{id}

HTTPcURLJavaScriptPython

GET /api/vds/shipment/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameterobjectOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsobjectOptional

Search-Dialog

customobjectOptional

Search-Dialog

textInterpolationDataobjectOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/vds/shipment/{id}

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2329

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

/vds/shipment/{id}

HTTPcURLJavaScriptPython

DELETE /api/vds/shipment/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

put

Path parameters

idinteger · int64Required

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameterobjectOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsobjectOptional

Search-Dialog

customobjectOptional

Search-Dialog

textInterpolationDataobjectOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

OK

*/*

put

/vds/shipment/{id}/validate

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id}/validate HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2329

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

put

Path parameters

idinteger · int64Required

id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameterobjectOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsobjectOptional

Search-Dialog

customobjectOptional

Search-Dialog

textInterpolationDataobjectOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

OK

*/*

put

/vds/shipment/{id}/updateWithRequestLabel

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id}/updateWithRequestLabel HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2329

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

requests a label from carrier

put

Path parameters

idinteger · int64Required

Body

application/json

Responses

200

OK

*/*

put

/vds/shipment/{id}/request-label

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id}/request-label HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "parameters": [
    {
      "key": "text",
      "value": {}
    }
  ]
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

Shipment-ID

parcelIdinteger · int64Required

Parcel-ID

Body

application/json

the parcels sent within this shipping order

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

widthnumberOptional

width of the parcel

heightnumberOptional

height of the parcel

lengthnumberOptional

length of the parcel

weightnumberOptional

weight of the parcel

trackingNumberstringOptional

tracking number of the parcel

packageParameterobjectOptional

Search-Dialog

shipmentIdinteger · int64Optional

The ID of the linked shipment

parcelStatestring · enumRequired

Paket-Status

Possible values:

carrierResponsestringOptional

carrier response information (e.g. error message)

validationErrorsobjectOptional

Search-Dialog

customobjectOptional

Search-Dialog

Responses

200

OK

*/*

put

/vds/shipment/{id}/parcels/{parcelId}

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id}/parcels/{parcelId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 973

{
  "version": "text",
  "info": {},
  "id": "text",
  "width": 1,
  "height": 1,
  "dimensionUnit": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "weight": 1,
  "weightUnit": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "trackingNumber": "text",
  "lines": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "parcelId": 1,
      "number": "text",
      "description": "text",
      "amount": 1,
      "grossWeight": 1,
      "grossWeightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "netWeight": 1,
      "netWeightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "grossPrice": 1,
      "netPrice": 1,
      "internationalParameter": {},
      "dangerousGoodsParameter": {},
      "custom": {}
    }
  ],
  "trackingDetails": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "statusCode": "CREATED",
      "carrierStatusCode": "text",
      "statusLabel": "text",
      "statusDetails": "text",
      "location": "text",
      "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
      "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
    }
  ],
  "packageParameter": {},
  "shipmentId": 1,
  "parcelState": "OPEN",
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {}
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "width": 1,
  "height": 1,
  "dimensionUnit": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "weight": 1,
  "weightUnit": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "trackingNumber": "text",
  "lines": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "parcelId": 1,
      "number": "text",
      "description": "text",
      "amount": 1,
      "grossWeight": 1,
      "grossWeightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "netWeight": 1,
      "netWeightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "grossPrice": 1,
      "netPrice": 1,
      "internationalParameter": {},
      "dangerousGoodsParameter": {},
      "custom": {}
    }
  ],
  "trackingDetails": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "statusCode": "CREATED",
      "carrierStatusCode": "text",
      "statusLabel": "text",
      "statusDetails": "text",
      "location": "text",
      "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
      "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
    }
  ],
  "packageParameter": {},
  "shipmentId": 1,
  "parcelState": "OPEN",
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {}
}

Print parcel label

put

Path parameters

idinteger · int64Required

shipment id

parcelIdinteger · int64Required

parcelId

Body

application/json

exportFormatstring · enumOptional

output forma für mail/file-export

Possible values:

exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

OutputReportGroup Identifier (optional), sonst Default-Group des Moduls

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Responses

200

OK

*/*

Responseobject

put

/vds/shipment/{id}/parcels/{parcelId}/print

HTTPcURLJavaScriptPython

PUT /api/vds/shipment/{id}/parcels/{parcelId}/print HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "exportFormat": "PDF",
  "exportFilename": "text",
  "outputType": "text",
  "groupIdentifier": "text",
  "published": true
}

200

OK

{}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameterobjectOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsobjectOptional

Search-Dialog

customobjectOptional

Search-Dialog

textInterpolationDataobjectOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

post

/vds/shipment

HTTPcURLJavaScriptPython

POST /api/vds/shipment HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2329

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {},
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-02-10",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "salutation": "text",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "type": "CONSIGNEE",
    "additionalAddressLine1": "text",
    "additionalAddressLine2": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "region": {
      "label": "text",
      "abbreviation": "text",
      "regionalCode": "text",
      "iso3166_2Code": "text"
    },
    "postcode": "text",
    "country": "text",
    "countryIso3": "text",
    "taxId": "text",
    "phone": "text",
    "fax": "text",
    "email": "text",
    "custom": {}
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:20:24.097Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:20:24.097Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": {},
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": {}
  },
  "deliveryMethodId": 1,
  "shipmentParameter": {},
  "parcels": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:20:24.097Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:20:24.097Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "width": 1,
      "height": 1,
      "dimensionUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "length": 1,
      "weight": 1,
      "weightUnit": {
        "id": 1,
        "name": "text",
        "abbreviation": "text"
      },
      "trackingNumber": "text",
      "lines": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "parcelId": 1,
          "number": "text",
          "description": "text",
          "amount": 1,
          "grossWeight": 1,
          "grossWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "netWeight": 1,
          "netWeightUnit": {
            "id": 1,
            "name": "text",
            "abbreviation": "text"
          },
          "grossPrice": 1,
          "netPrice": 1,
          "internationalParameter": {},
          "dangerousGoodsParameter": {},
          "custom": {}
        }
      ],
      "trackingDetails": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:20:24.097Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:20:24.097Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "statusCode": "CREATED",
          "carrierStatusCode": "text",
          "statusLabel": "text",
          "statusDetails": "text",
          "location": "text",
          "trackingCreatedAt": "2026-02-10T14:20:24.097Z",
          "trackingUpdatedAt": "2026-02-10T14:20:24.097Z"
        }
      ],
      "packageParameter": {},
      "shipmentId": 1,
      "parcelState": "OPEN",
      "carrierResponse": "text",
      "validationErrors": {},
      "custom": {}
    }
  ],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": {},
  "custom": {},
  "textInterpolationData": {},
  "shipmentState": "OPEN"
}