Shipment

the shipment API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

404

Resource with given ID was not found

*/*

get/vds/shipment/{id}

GET /api/vds/shipment/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

successful operation

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put/vds/shipment/{id}

PUT /api/vds/shipment/{id} HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1460

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-01-01",
  "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": null
  },
  "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": null
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

*/*

409

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

*/*

delete/vds/shipment/{id}

DELETE /api/vds/shipment/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

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

put

Path parameters

idinteger · int64Required

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

put/vds/shipment/{id}/validate

PUT /api/vds/shipment/{id}/validate HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1460

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-01-01",
  "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": null
  },
  "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": null
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

put

Path parameters

idinteger · int64Required

id

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

put/vds/shipment/{id}/updateWithRequestLabel

PUT /api/vds/shipment/{id}/updateWithRequestLabel HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1460

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-01-01",
  "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": null
  },
  "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": null
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

requests a label from carrier

put

Path parameters

idinteger · int64Required

Body

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

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

PUT /api/vds/shipment/{id}/request-label HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "parameters": []
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

Shipment-ID

parcelIdinteger · int64Required

Parcel-ID

Body

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

packageParameteranyOptional

Search-Dialog

shipmentIdinteger · int64Optional

The ID of the linked shipment

parcelStatestring · enumRequired

Paket-Status

Possible values:

carrierResponsestringOptional

carrier response information (e.g. error message)

validationErrorsanyOptional

Search-Dialog

customanyOptional

Search-Dialog

Responses

200

OK

*/*

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

packageParameteranyOptional

Search-Dialog

shipmentIdinteger · int64Optional

The ID of the linked shipment

parcelStatestring · enumRequired

Paket-Status

Possible values:

carrierResponsestringOptional

carrier response information (e.g. error message)

validationErrorsanyOptional

Search-Dialog

customanyOptional

Search-Dialog

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

PUT /api/vds/shipment/{id}/parcels/{parcelId} HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 381

{
  "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": [],
  "trackingDetails": [],
  "packageParameter": null,
  "shipmentId": 1,
  "parcelState": "OPEN",
  "carrierResponse": "text",
  "validationErrors": null,
  "custom": null
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "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": [],
  "trackingDetails": [],
  "packageParameter": null,
  "shipmentId": 1,
  "parcelState": "OPEN",
  "carrierResponse": "text",
  "validationErrors": null,
  "custom": null
}

Print parcel label

put

Path parameters

idinteger · int64Required

shipment id

parcelIdinteger · int64Required

parcelId

Body

exportFormatstring · enumOptional

output-format 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?

Default: false

Responses

200

OK

*/*

anyOptional

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

PUT /api/vds/shipment/{id}/parcels/{parcelId}/print HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "exportFormat": "PDF",
  "exportFilename": "text",
  "mailRecipients": [],
  "outputType": "text",
  "groupIdentifier": "text",
  "published": false
}

200

OK

No content

Create new Resource

post

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

Responses

200

successful operation

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

shippingDatestring · dateOptional

shipping date

deliveryMethodIdinteger · int64Optional

ID der Versandart

shipmentParameteranyOptional

Search-Dialog

documentIdinteger · int64Required

document id

carrierResponsestringOptional

carrier response / warning or error messages

validationErrorsanyOptional

Search-Dialog

documentNumberstringOptional

Rechnungsnummer

shippingCostsnumberOptional

Versandkosten

customanyOptional

Search-Dialog

textInterpolationDataanyOptional

Search-Dialog

shipmentStatestring · enumOptional

state of the shipment

Possible values:

422

Resource was not valid to process

*/*

post/vds/shipment

POST /api/vds/shipment HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1460

{
  "version": "text",
  "info": {},
  "id": "text",
  "shippingDate": "2026-01-01",
  "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": null
  },
  "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": null
  },
  "carrier": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text"
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "shippingDate": "2026-01-01",
  "shipperAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "receiverAddress": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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": null
  },
  "carrier": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "parameter": null,
    "carrierTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true,
    "custom": null
  },
  "deliveryMethodId": 1,
  "shipmentParameter": null,
  "parcels": [],
  "documentId": 1,
  "carrierResponse": "text",
  "validationErrors": null,
  "documentNumber": "text",
  "currencyCodeRef": {
    "id": 1,
    "isoAlpha3": "text",
    "label": "text",
    "symbol": "text"
  },
  "shippingCosts": 1,
  "custom": null,
  "textInterpolationData": null,
  "shipmentState": "OPEN"
}