Adnymics API (1.0.0)

Download OpenAPI specification:Download

Adnymics API v1

Access is provided via a RESTful API in the Adnymics cloud. Communication with the server is secured by using SSL and a basic authentication with user name and password that will be provided to you by the integration team. Please use ports 8443 with a selfsigned certificate which is also provided by the integration team. Use port 8080 if the certification is to be handled by a central certification authority (Let's Encrypt)

API Host

Connect to the API at https://api.adnymics.com:8443/v1/{customerID}/

Generation Call

Triggers the generation of an Insert.

Triggers the generation of an Insert. The Inserts will be kept on the hard drive until they can be printed. The ideal time for generating an Insert is as soon as all required information for the Insert is available.

Request Body schema: application/json
orderId
required
string

A unique ID for the order for which the Insert should be generated. The order-ID can be provided by the shop system but has to match the order-ID also provided in print trigger.

customerId
required
string

Unique ID for the customer for whom the Insert should be generated. An e-mail address or the specific customer ID from the shop system can be used. This ID has to match the Customer ID defined in your online tracking user identification. Consider hashing the user ID if e-mail address is being used.

customerName
required
string

First name of the customer for whom the Insert should be generated.

customerSurname
string

The last name of the customer for whom the Insert should be generated.

customerGender
required
string
Enum: "0" "1" "2"

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

customerEMail
string

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

custAddrStreet
required
string

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

custAddrZip
required
string

ZIP code of the customer for whom the Insert should be generated.

custAddrCity
string

City of the customer for whom the Insert should be generated.

custAddrCountry
string

Country of the customer for whom the Insert should be generated.

custDateOfBirth
string

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

language
required
string

The language and country of the customer for whom the Insert 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. In our example this results in de_CH for language.

productId
Array of strings

Unique ID’s for products that the customer ordered in this order. These ID's have to correspond to the product ID's that characterizes the product in the product data feed. This parameter can be defined multiple times to pass all products to the current order.

couponCode
string

If you don’t use our Adnymics Dashboard to create coupon campaigns online, you can transmit the codes with the order data here. dynamic variant: Coupon code that is individualized for the order and should be printed in the Insert for the customer.

couponValue
string

Date, when the coupon code should be used for the last time (until 12a.m.) (mandatory, if using couponCode)

couponUnit
string
Enum: "percent" "currency"

With the value „currency“ the coupon code is printed as currency (The currency is Inserted automatically corresponding to the language of the template – e.g. 10€). With the value „percent“ the coupon code is printed as percentage. (eg. 10%). (mandatory, if using couponCode)

couponThreshold
string

Defines the minimum shopping value, that has to be reached in order to use the coupon code. (mandatory, if using couponCode)

couponValidityDate
string

Date, when the coupon code should be used for the last time (until 12a.m.) (mandatory, if using couponCode)

orderCouponCode
string

Coupon code that is redeemed by the customer with the order. It is also used in order to analyse performance issues (conversion rate in Adnymics Cockpit) and thereby enhance the quality of the selection algorithm.

rebuy
boolean
Enum: true false null

With the value true, if order is placed by customer who has bought before (=repeat customer). With the value false, if order is placed by customer for the first time. (=new customer). If this value is not set, Adnymics compares orders with accessible data base and defines the value. This can lead to discrepancies. (Result can be seen in Adnymics Cockpit).

companyName
string

Company Name of the customer for whom the Insert should be generated.

segmentName
string

Segment name of order. (e.g. sports, electronics…). Name has to correspond to an existing segment defined together with Adnymics.

generate
boolean
Enum: true false

With the value true a Insert will be printed for the customer. With the value false no Insert will be printed for the customer. If this value is not set, Adnymics automatically the value true. If you (don’t) want to print Insert for orders over platforms (e.g. ebay), you can control it with this parameter.

couponCodeBarcode
string

If you want to use our 128-bit Barcode within the Insert place the value here. This allows you do hand over a certain dynamic variant: Coupon code that is individualized for the order and should be printed in the Insert for the customer. Alternatively a static coupon code can be inserted directly from the template.

couponValidityDateBarcode
string

The date, when the coupon code should be used for the last time (until 12a.m.). (mandatory, if using couponCodeBarcode)

couponValueBarcode
string

Value of a coupon code that is individualized for the order and is printed in the Insert for the customer as barcode. In case of a percentage discount this is also added via the template. (mandatory, if using couponCodeBarcode)

couponUnitBarcode
string
Enum: "currency" "percent"

With the value currency the coupon code is printed as currency (The currency is inserted automatically corresponding to the language of the template – e.g. 10€). With the value „percent“ the coupon code is printed as percentage. (eg. 10%). (mandatory, if using couponCodeBarcode)

couponThresholdBarcode
string

Defines the minimum shopping value, that has to be reached in order to use the coupon code (e.g. 50€). (mandatory, if using couponCodeBarcode)

loyaltyPoints
string

Total loyalty points.

loyaltyStatus
string

Name of the customer's current loyalty status.

loyaltyPointsPurchase
string

Totaly loyalty points gained with the current purchase.

loyaltyPointsDelta
string

Points left for the next status level.

Responses

Request samples

Content type
application/json
{
  • "orderId": "ORD-1",
  • "customerId": "CUST-1",
  • "customerName": "Klaus",
  • "customerSurname": "Meier",
  • "customerGender": "0",
  • "customerEMail": "[email protected]",
  • "custAddrStreet": "Musterstr. 1",
  • "custAddrZip": "12345",
  • "custAddrCity": "Müsterstadt",
  • "custAddrCountry": "Deutschland",
  • "custDateOfBirth": "01.04.1980",
  • "language": "de_DE",
  • "productId": [
    ],
  • "couponCode": "492232847370021524",
  • "couponValue": "31.12.2019",
  • "couponUnit": "percent",
  • "couponThreshold": "50",
  • "couponValidityDate": "31.12.2019",
  • "orderCouponCode": "string",
  • "rebuy": true,
  • "companyName": "ACME, Inc.",
  • "segmentName": "millenials",
  • "generate": true,
  • "couponCodeBarcode": "492232847370021524",
  • "couponValidityDateBarcode": "31.12.2019",
  • "couponValueBarcode": "15",
  • "couponUnitBarcode": "percent",
  • "couponThresholdBarcode": "50",
  • "loyaltyPoints": "10900",
  • "loyaltyStatus": "silver",
  • "loyaltyPointsPurchase": "300",
  • "loyaltyPointsDelta": "8800"
}

Response samples

Content type
application/json
{
  • "success": true
}

Print Call

Triggers the printing of a single Insert.

Triggers the printing of a single Insert. If you work together with a fulfillment service provider, this interface has to be configured by the IT of that service provider.

Request Body schema: application/json
orderId
required
string

Unique ID for the order for which the Insert should be printed. This ID has to be the same that was passed when generating the Insert.

customerId
string
language
string
packagingStation
string

According to this value it is decided to which printer the Insert will be sent.

packageReferenceNumber
string
packageBarcode
string

Responses

Request samples

Content type
application/json
{
  • "orderId": "ORD-1",
  • "customerId": "",
  • "language": "de_DE",
  • "packagingStation": "1",
  • "packageReferenceNumber": "ADFG45G",
  • "packageBarcode": "987654321"
}

Response samples

Content type
application/json
{
  • "success": true
}

Logistics IT

Triggers the printing of a series of Inserts.

Triggers the printing of a series of Inserts. If you work together with a fulfillment service provider, this interface has to be configured by the IT of that service provider.

Request Body schema: application/json

A JSON String of a list of identification numbers (orderId, packageReferenceNumber, packageBarcode) for the orders.

batchId
required
string

Unique ID for the order for which the Insert should be printed. Here, for instance, the order ID of the shop data base can be used. This ID has to be the same that was passed when generating the Insert.

required
Array of objects

A JSON array of identification numbers (orderId, packageReferenceNumber, packageBarcode) for the orders.

packagingStation
string

According to this value it is decided to which printer the Insert will be sent.

Responses

Request samples

Content type
application/json
{
  • "batchId": "123456789",
  • "orders": [
    ],
  • "packagingStation": "PackagingStation1"
}

Response samples

Content type
application/json
{
  • "success": true
}