API documentation

getLabel
Documentation Powered by Redocly

getLabel (1.0)

Download OpenAPI specification:Download

Access is provided via a RESTful API in the cloud, communication with the server is secured by using SSL and API Key that will be provided to you by the integration team.

Authentication

X-API-Key

Security Scheme Type API Key
Header parameter name: X-API-Key

Get personalized label

Get personalized label with ads for specific order

Request Body schema: application/json
customerName
required
string non-empty

First name of the customer for whom the label should be generated

customerSurname
string non-empty

The last name of the customer for whom the label should be generated

custAddrZip
required
string non-empty

ZIP code of the customer for whom the label should be generated

custAddrCountry
required
string non-empty

Country of the customer for whom the label should be generated

referenceID
string non-empty

To ensure idempotency of request you can provide any kind of external identifier (parcelID, orderID, shipmentID)

custAddrStreet
string non-empty

Street name of the customer for whom the label should be generated.

custAddrCity
string non-empty

City of the customer for whom the label should be generated

customerGender
integer
Enum: 0 1 2

Gender of the customer for whom the label should be generated. (0: male; 1 female, 2: unknown/unisex)

language
string non-empty

The language of the customer for whom the label should be generated. For language identification please use norm ISO-639-1 with its double digit language code, e.g. „de“ for German and combine it with the double-digit country code from ISO-3166, e.g. „CH“ for Switzerland.

customerDateOfBirth
string non-empty

Date of birth of the customer for whom the label should be generated. **The passed value has the format „DD.MM.YYYY“ (D = day, M = month, Y = year)

customerEMail
string non-empty

E-mail-address of the customer for whom the Insert should be generated

labelFormat
string non-empty

Size of the label (if different sizes are used), f.e. 101x152

amount
integer

How many labels to return (if more than one will be printed)

Array of objects non-empty unique [ items ]

Products that the customer ordered in this order

Responses

Request samples

Content type
application/json
{
  • "customerName": "Klaus",
  • "customerSurname": "Meier",
  • "custAddrZip": "12345",
  • "custAddrCountry": "Deutschland",
  • "custAddrStreet": "Musterstr. 1",
  • "custAddrCity": "Musterstadt",
  • "customerGender": 0,
  • "language": "de_DE",
  • "customerDateOfBirth": "01.04.1980",
  • "customerEMail": "klaus.meier@example.com",
  • "labelFormat": "101x152",
  • "amount": 1,
  • "products": [
    ]
}

Response samples

Content type
application/pdf
{}