tonies SE
API docs by Redocly

Arvato openAPI (1.0.5)

Download OpenAPI specification:Download

Enterprise Integration: team.enterprise-integration@tonies.com URL: https://boxine.atlassian.net/wiki/spaces/EI/overview Terms of Service

Arvato API Setup

This document describes the API provided by Arvato via Seeburger for tonies to handle all 3PL matters.

tonies - Arvato Communication Overview

A complete Architecture Overview can be found in Miro . Arvato API Setup

materialMaster

Updates the Master-Data from tonies. Arvato needs all infos about our products to handle them properly, hence we need to share our master data with them.

Authorizations:
api_key
Request Body schema: application/json
required

A single, or multiple items of material master objects.

Array of objects (itemMaster)
Array
plant
required
string (ArvatoPlant)
Enum: "DE" "UK"

Determines the location of the item(s). Currently in UK or DACH. Is always a two-letter country code. ISO 3166-1 alpha-2 FOR DOCUMENTATION PURPOSES ONLY: Arvato maps these values to

  • E074 = Gütersloh = DE
  • E076(?) = London = UK or GB -> TBD
sku
required
string (SKU)

SKU / Article No, Max Char18

ean
required
string

Max Char18

eanMasterCarton
string

Max Char18

serialNumberRequired
required
boolean

If this field is 'true', Arvato need to scan the SNs

skuDescription
required
string (SKUDescription)

Serves the readability of the json. Arvato already has the material text, even with more than 40 characters, in the system through the material master, cut off after 40 characters by Arvato

commodityCode
required
string

Max Char17

countryOfOrigin
required
string (Country)
Enum: "DE" "US" "GB" "ES" "FR" "IE" "AT" "AU" "UK"

Two-Letter Country Code. - ISO 3166-1 alpha-2

unNumber
string

Only necessary if we ship dangerous goods (batteries)

inventoryValue
required
number <double>

Monetary value for insurance reasons, max 9 pre-decimal, max 2 decimal, cut off after 2 decimal by arvato

Responses

Request samples

Content type
application/json
{
  • "material": [
    ]
}

Response samples

Content type
application/json
{
  • "material": [
    ]
}

purchaseOrder

Purchase Order. tonies announces one ore more incoming shipments from our suppliers to Arvato. In return Arvato will create a Receiving Advice with the stuff of what arrived at the warehouse from the warehouse.

Authorizations:
api_key
Request Body schema: application/json
required

A single, or multiple shipments to announce.

Array of objects (PurchaseOrderItems)
Array
referenceDocumentNumber
required
string

Purchase Order ID (primary Key) in tonies ERP. Also to be found on the receiving advice Max Char12

vendorShipmentNumber
string

Delivery Code Reference from vendor, used by Arvato to identify the delivery. Max Char12

plant
required
string (ArvatoPlant)
Enum: "DE" "UK"

Determines the location of the item(s). Currently in UK or DACH. Is always a two-letter country code. ISO 3166-1 alpha-2 FOR DOCUMENTATION PURPOSES ONLY: Arvato maps these values to

  • E074 = Gütersloh = DE
  • E076(?) = London = UK or GB -> TBD
required
Array of objects (PurchaseOrderItem)
Array
lineNumber
required
string (Linenumber)

reference + line number are for exact identification, max 18 digits

sku
required
string (SKU)

SKU / Article No, Max Char18

quantity
required
integer <int32> (Quantity)

Unit is always Piece = Stück.Max 18 digits

locationCode
required
string (ArvatoLocationCode)
Enum: "0001" "0002" "0003" "0004" "0005" "0006" "0007"

We manage material quality (new / damaged etc.) with this value. Char4

  • 0001 - Available Good stock available for orders
  • 0002 - Scrap Damage stock not available for orders
  • 0003 - Returns Stock out of returns not available for orders
  • 0004 - Dirty Blocked stock for rework not available for orders
  • 0005 - Quarantine Blocked stock for any reason not available for orders
  • 0006 - Refurbish Within rework not available for orders
  • 0007 - Cross Dock Cross dock interim storage Only available in combination with cross dock customer

Responses

Request samples

Content type
application/json
{
  • "purchaseOrder": [
    ]
}

Response samples

Content type
application/json
{
  • "purchaseOrder": [
    ]
}

salesOrder

Sales Orders for Arvato to deliver to our customers B2C & B2B. One order per request,

Authorizations:
api_key
Request Body schema: application/json
required

A single order with one or many items

referenceDocumentNumber
required
string

Delivery Code max 35 characters

orderNumber
required
string (OrderNumber)

Order number max 35 characters

externalNumber1
string

External document number (print on delivery note) max 250 characters

externalNumber2
string

External document number (print on delivery note) max 250 characters

plant
required
string (ArvatoPlant)
Enum: "DE" "UK"

Determines the location of the item(s). Currently in UK or DACH. Is always a two-letter country code. ISO 3166-1 alpha-2 FOR DOCUMENTATION PURPOSES ONLY: Arvato maps these values to

  • E074 = Gütersloh = DE
  • E076(?) = London = UK or GB -> TBD
expressDelivery
boolean

In Case the Order needs to be handled as Express e.g. with UPS for B2C. Defaults to fault

pgiDate
required
string (Date-YYYY-MM-DD)

pgi date /// Whse Shipment Date (Sales Order Line) oder "Due Date" (Whse Shipment Line)

reqDeliveryDate
string (Date-YYYY-MM-DD)

In ISO8601 format YYYY-MM-DD

launchCode
string (Date-YYYY-MM-DD)

In ISO8601 format YYYY-MM-DD

incoterms1
required
string

Incoterms, always DDP - Delivered Duty Paid max 3 characters

currency
string (Currency)
Enum: "EUR" "USD" "GBP" "AUD" "NZD"

Currency - ISO_4217

required
Array of objects (SalesOrderItem)
Array
lineNumber
required
string (Linenumber)

reference + line number are for exact identification, max 18 digits

sku
required
string (SKU)

SKU / Article No, Max Char18

skuExternal
string (SKU)

SKU / Article No, Max Char18

quantity
required
integer <int32> (Quantity)

Unit is always Piece = Stück.Max 18 digits

skuDescription
required
string (SKUDescription)

Serves the readability of the json. Arvato already has the material text, even with more than 40 characters, in the system through the material master, cut off after 40 characters by Arvato

customsValue
number <double>

Per piece, as partial delivery possible - Verkaufspreis, pro Stück, abzüglich Zeilenrabatt.

locationCode
required
string (ArvatoLocationCode)
Enum: "0001" "0002" "0003" "0004" "0005" "0006" "0007"

We manage material quality (new / damaged etc.) with this value. Char4

  • 0001 - Available Good stock available for orders
  • 0002 - Scrap Damage stock not available for orders
  • 0003 - Returns Stock out of returns not available for orders
  • 0004 - Dirty Blocked stock for rework not available for orders
  • 0005 - Quarantine Blocked stock for any reason not available for orders
  • 0006 - Refurbish Within rework not available for orders
  • 0007 - Cross Dock Cross dock interim storage Only available in combination with cross dock customer
required
object

Basic Address Schema

name
string

Partner Name max XX characters

name2
string

Partner Name max XX characters

city
string

City max XX characters

address
string

Street + HouseNo max XX characters

address2
string

additional address info, max XX characters

country
required
string (Country)
Enum: "DE" "US" "GB" "ES" "FR" "IE" "AT" "AU" "UK"

Two-Letter Country Code. - ISO 3166-1 alpha-2

zip
string

Zip Code, max XX characters

tel
string

Phone / Landline Number, max XX characters

mail
string

Email Address max XX characters

region
string

e.g. NV = Nevada, two-letter code max 2 characters

shipToReference
required
string

Tonies Customer number, Arvato creates customer master data (except for B2C)

object (BasicAddressSchema)

Basic Address Schema

name
string

Partner Name max XX characters

name2
string

Partner Name max XX characters

city
string

City max XX characters

address
string

Street + HouseNo max XX characters

address2
string

additional address info, max XX characters

country
required
string (Country)
Enum: "DE" "US" "GB" "ES" "FR" "IE" "AT" "AU" "UK"

Two-Letter Country Code. - ISO 3166-1 alpha-2

zip
string

Zip Code, max XX characters

tel
string

Phone / Landline Number, max XX characters

mail
string

Email Address max XX characters

Responses

Request samples

Content type
application/json
{
  • "referenceDocumentNumber": "string",
  • "orderNumber": "string",
  • "externalNumber1": "string",
  • "externalNumber2": "string",
  • "plant": "DE",
  • "expressDelivery": true,
  • "pgiDate": "string",
  • "reqDeliveryDate": "string",
  • "launchCode": "string",
  • "incoterms1": "string",
  • "currency": "EUR",
  • "items": [
    ],
  • "shipToParty": {
    },
  • "billToParty": {
    }
}

Response samples

Content type
application/json
{
  • "referenceDocumentNumber": "string",
  • "orderNumber": "string",
  • "externalNumber1": "string",
  • "externalNumber2": "string",
  • "plant": "DE",
  • "expressDelivery": true,
  • "pgiDate": "string",
  • "reqDeliveryDate": "string",
  • "launchCode": "string",
  • "incoterms1": "string",
  • "currency": "EUR",
  • "items": [
    ],
  • "shipToParty": {
    },
  • "billToParty": {
    }
}

rma

Return Merchandise Authorization (RMA) for Arvato to announce a return request

Authorizations:
api_key
Request Body schema: application/json
required

A single return request with one or many items

referenceDocumentNumber
required
string

Tonies RMA Number, created by tonies - used in the return advice as well Max Char35

plant
required
string (ArvatoPlant)
Enum: "DE" "UK"

Determines the location of the item(s). Currently in UK or DACH. Is always a two-letter country code. ISO 3166-1 alpha-2 FOR DOCUMENTATION PURPOSES ONLY: Arvato maps these values to

  • E074 = Gütersloh = DE
  • E076(?) = London = UK or GB -> TBD
trackingNumber
required
string

Tracking ID / Number from DHL/UPS/etc

Array of objects
Array
lineNumber
required
string (Linenumber)

reference + line number are for exact identification, max 18 digits

sku
required
string (SKU)

SKU / Article No, Max Char18

quantity
required
integer <int32> (Quantity)

Unit is always Piece = Stück.Max 18 digits

comment
string

optional comment from tonies

object (RMAAddressSchema)

RMA Address Schema

name
required
string

Partner Name max 35 characters

city
required
string

City max 35 characters

address
required
string

Street + HouseNo max 35 characters

country
required
string (Country)
Enum: "DE" "US" "GB" "ES" "FR" "IE" "AT" "AU" "UK"

Two-Letter Country Code. - ISO 3166-1 alpha-2

zip
required
string

Zip Code, max 10 characters

Responses

Request samples

Content type
application/json
{
  • "referenceDocumentNumber": "string",
  • "plant": "DE",
  • "trackingNumber": "string",
  • "items": [
    ],
  • "shipFromParty": {
    }
}

Response samples

Content type
application/json
{
  • "referenceDocumentNumber": "string",
  • "plant": "DE",
  • "trackingNumber": "string",
  • "items": [
    ],
  • "shipFromParty": {
    }
}

productionOrder

Production Order. tonies requests the production of a certain kind from Arvato (e.g. creation of a bundle). In return Arvato will create a Production Rec Advive with new finished SKU.

Authorizations:
api_key
Request Body schema: application/json
required

A single production order request.

required
object
referenceDocumentNumber
required
string

(primary Key) in tonies ERP. Max Char20

productionOrderType
required
string (ArvatoProductionOrderType)
Value: "BUND"

Determines the type of Production Order to be produced. E.g. BUND -> bundling

plant
required
string (ArvatoPlant)
Enum: "DE" "UK"

Determines the location of the item(s). Currently in UK or DACH. Is always a two-letter country code. ISO 3166-1 alpha-2 FOR DOCUMENTATION PURPOSES ONLY: Arvato maps these values to

  • E074 = Gütersloh = DE
  • E076(?) = London = UK or GB -> TBD
startDate
string (Date-YYYY-MM-DD)

In ISO8601 format YYYY-MM-DD

dueDate
string (Date-YYYY-MM-DD)

In ISO8601 format YYYY-MM-DD

product
required
string (SKU)

Finished Product SKU

quantity
required
integer <int32> (Quantity)

Unit is always Piece = Stück.Max 18 digits

Array of objects (ProductionOrderItem)
Array
lineNumber
required
string (Linenumber)

reference + line number are for exact identification, max 18 digits

sku
required
string (SKU)

SKU / Article No, Max Char18

quantity
required
integer <int32> (Quantity)

Unit is always Piece = Stück.Max 18 digits

locationCode
required
string (ArvatoLocationCode)
Enum: "0001" "0002" "0003" "0004" "0005" "0006" "0007"

We manage material quality (new / damaged etc.) with this value. Char4

  • 0001 - Available Good stock available for orders
  • 0002 - Scrap Damage stock not available for orders
  • 0003 - Returns Stock out of returns not available for orders
  • 0004 - Dirty Blocked stock for rework not available for orders
  • 0005 - Quarantine Blocked stock for any reason not available for orders
  • 0006 - Refurbish Within rework not available for orders
  • 0007 - Cross Dock Cross dock interim storage Only available in combination with cross dock customer

Responses

Request samples

Content type
application/json
{
  • "productionOrder": {
    }
}

Response samples

Content type
application/json
{
  • "productionOrder": {
    }
}