Download OpenAPI specification:
POST-endpoint to retrieve a new Bearer token to be used in futrure requests. Use the provided client_id and client_secret in the request. The audience and grant_type are already provided in the sample request.
Token request payload
| client_id | string |
| client_secret | string |
| audience | string |
| grant_type | string |
client_id=string&client_secret=string&audience=https%3A%2F%2Forderchief.semso.io&grant_type=client_credentials
{- "access_token": "string",
- "scope": "string",
- "expires_in": 86400,
- "token_type": "Bearer"
}This POST method allows to add items through the OrderChief API
Request body for adding item
object (incommingMessageHeader) | |
object (itemMessage) |
{- "header": {
- "channel": "string"
}, - "message": {
- "harmonizedSystemCode": "string",
- "name": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "longName": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "description": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "shortDescription": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "prices": [
- {
- "type": "SELLING",
- "amount": 0.1,
- "isInclusiveVat": true,
- "vatPercentage": 0.1,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "currency": "AED",
- "countryIso": "string"
}
], - "priceGroupPrices": [
- {
- "type": "AMOUNT",
- "priceGroup": "string",
- "amount": 0.1,
- "minimumQuantity": 0,
- "isInclusiveVat": true,
- "vatPercentage": 0.1,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "currency": "AED",
- "countryIso": "string"
}
], - "shippingPrices": [
- {
- "countryIso": "string",
- "transporterCode": "string",
- "transporterDescription": "string",
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1,
- "currency": "AED"
}
], - "brand": "string",
- "categories": [
- "string"
], - "attributes": [
- {
- "attributeKey": "string",
- "sortOrder": 0,
- "attributeDescriptions": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "attributeNames": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "attributeValues": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string",
- "valueKey": "string"
}
]
}
], - "images": [
- {
- "key": "string",
- "isMain": true,
- "languageIso": "string",
- "sortOrder": 0,
- "url": "string",
- "altTag": "string",
- "base64Data": "string",
- "contentType": "string",
- "modified": "2019-08-24T14:15:22Z"
}
], - "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}, - "productType": "string",
- "supplier": "string",
- "parent": {
- "key": "string",
- "ean": "string",
- "code": "string"
}, - "isParent": true,
- "published": true,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "handle": "string",
- "seo": {
- "title": "string",
- "description": "string",
- "handle": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "metaTitle": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "metaDescription": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
], - "metaKeywords": [
- {
- "isDefault": true,
- "languageIso": "string",
- "value": "string"
}
]
}, - "sorting": "string",
- "initialStock": 0.1,
- "tags": [
- {
- "isDefault": true,
- "languageIso": "string",
- "name": "string"
}
], - "supplierCode": "string",
- "isDeleted": true,
- "relatedItems": [
- {
- "key": "string",
- "ean": "string",
- "code": "string"
}
], - "crossSellItems": [
- {
- "key": "string",
- "ean": "string",
- "code": "string"
}
], - "upSellItems": [
- {
- "key": "string",
- "ean": "string",
- "code": "string"
}
], - "key": "string",
- "ean": "string",
- "code": "string"
}
}This POST method allows to add orderAcks through the OrderChief API
Request body for adding orderAck
object (incommingMessageHeader) | |
object (orderAckMessage) |
{- "header": {
- "channel": "string"
}, - "message": {
- "originalReference": "string",
- "assignedReference": "string",
- "acknowledgedType": "ACKNOWLEDGED"
}
}This POST method allows to add orders through the OrderChief API
Request body for adding order
object (incommingMessageHeader) | |
object (orderMessage) |
{- "header": {
- "channel": "string"
}, - "message": {
- "key": "string",
- "type": "ORDER",
- "number": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "status": "NEW",
- "state": "string",
- "isBusinessOrder": true,
- "yourReference": "string",
- "paymentReference": "string",
- "payment": {
- "method": "OTHER",
- "description": "string",
- "reference": "string"
}, - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "comment": "string",
- "currency": "AED",
- "shipping": {
- "method": "string",
- "costs": 0.1,
- "costsIncludingVat": 0.1,
- "costsExcludingVat": 0.1,
- "unitPriceIncludingVat": 0.1,
- "unitPriceExcludingVat": 0.1,
- "quantity": 0,
- "vatPercentage": 0.1
}, - "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "buyer": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "delivery": {
- "isPickUpPoint": true,
- "pickUpPointName": "string",
- "pickUpPointFields": [
- {
- "key": "string",
- "value": "string"
}
], - "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "supplier": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "invoicee": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "orderLines": [
- {
- "key": "string",
- "lineNumber": 0,
- "itemEAN": "string",
- "itemCode": "string",
- "itemCodeSupplier": "string",
- "itemDescription": "string",
- "remarks": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "quantity": 0.1,
- "itemPriceIncludingVat": 0.1,
- "itemPriceExcludingVat": 0.1,
- "vatPercentage": 0.1,
- "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
], - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "costCenter": "string",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "tags": [
- "string"
]
}
], - "additionalParties": [
- {
- "type": "COMMISIONEDDEALER",
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
], - "shipFromCountryIso": "string",
- "shipToCountryIso": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
]
}
}This POST method allows to add shipments through the OrderChief API
Request body for adding shipment
object (incommingMessageHeader) | |
object (shipmentMessage) |
{- "header": {
- "channel": "string"
}, - "message": {
- "key": "string",
- "shipmentNumber": "string",
- "status": "NEW",
- "orderNumber": "string",
- "orderReference": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "orderKey": "string",
- "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "fulFillmentType": "MERCHANT",
- "comment": "string",
- "buyer": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "delivery": {
- "isPickUpPoint": true,
- "pickUpPointName": "string",
- "pickUpPointFields": [
- {
- "key": "string",
- "value": "string"
}
], - "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "supplier": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "additionalParties": [
- {
- "type": "COMMISIONEDDEALER",
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
], - "transport": {
- "transporterCode": "string",
- "transporterDescription": "string",
- "trackAndTrace": "string",
- "trackAndTraceUri": "string"
}, - "shipmentLoadCarriers": [
- {
- "loadCarrierEAN": "string",
- "loadCarrierCode": "string",
- "loadCarrierDescription": "string",
- "loadCarrierQuantity": 0.1,
- "loadCarrierType": "string",
- "loadCarrierWeight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "sscc": "string",
- "shipmentLines": [
- {
- "key": "string",
- "lineNumber": 0,
- "itemEAN": "string",
- "itemCode": "string",
- "itemDescription": "string",
- "remarks": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "quantityDelivered": 0.1,
- "bestBeforeDate": "2019-08-24T14:15:22Z",
- "batchNumber": "string",
- "transport": {
- "transporterCode": "string",
- "transporterDescription": "string",
- "trackAndTrace": "string",
- "trackAndTraceUri": "string"
}, - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "orderNumber": "string",
- "orderReference": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "orderRemarks": "string",
- "orderLineKey": "string",
- "orderLineRemarks": "string",
- "serialNumbers": [
- "string"
], - "crate": {
- "quantity": 0.1,
- "type": "string",
- "graiNumber": "string",
- "ean": "string",
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
]
}
}
]
}
], - "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "warehouse": {
- "code": "string",
- "description": "string",
- "identifier": "string",
- "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
}
}This POST method allows to add stockmutations through the OrderChief API
Request body for adding stock mutations
object (incommingMessageHeader) | |
Array of objects (stockMessage) |
{- "header": {
- "channel": "string"
}, - "message": [
- {
- "itemEAN": "string",
- "itemCode": "string",
- "inStock": 0.1
}
]
}This method is not supported and only provides documentation regarding the models.
{- "header": {
- "source": "string",
- "channel": "string"
}, - "message": {
- "key": "string",
- "type": "ORDER",
- "number": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "status": "NEW",
- "state": "string",
- "isBusinessOrder": true,
- "yourReference": "string",
- "paymentReference": "string",
- "payment": {
- "method": "OTHER",
- "description": "string",
- "reference": "string"
}, - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "comment": "string",
- "currency": "AED",
- "shipping": {
- "method": "string",
- "costs": 0.1,
- "costsIncludingVat": 0.1,
- "costsExcludingVat": 0.1,
- "unitPriceIncludingVat": 0.1,
- "unitPriceExcludingVat": 0.1,
- "quantity": 0,
- "vatPercentage": 0.1
}, - "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "buyer": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "delivery": {
- "isPickUpPoint": true,
- "pickUpPointName": "string",
- "pickUpPointFields": [
- {
- "key": "string",
- "value": "string"
}
], - "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "supplier": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "invoicee": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "orderLines": [
- {
- "key": "string",
- "lineNumber": 0,
- "itemEAN": "string",
- "itemCode": "string",
- "itemCodeSupplier": "string",
- "itemDescription": "string",
- "remarks": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "quantity": 0.1,
- "itemPriceIncludingVat": 0.1,
- "itemPriceExcludingVat": 0.1,
- "vatPercentage": 0.1,
- "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
], - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "costCenter": "string",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "tags": [
- "string"
]
}
], - "additionalParties": [
- {
- "type": "COMMISIONEDDEALER",
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
], - "shipFromCountryIso": "string",
- "shipToCountryIso": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
]
}
}This method is not supported and only provides documentation regarding the models.
{- "header": {
- "source": "string",
- "channel": "string"
}, - "message": {
- "deliveryStatus": "OPEN",
- "orderStatus": "string",
- "invoiceStatus": "OPEN",
- "paymentStatus": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orderReference": "string",
- "totalIncludingVat": 0.1,
- "totalExcludingVat": 0.1,
- "totalVat": 0.1,
- "orderLines": [
- {
- "quantityDelivered": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1,
- "state": "string",
- "quantityCancelled": 0.1,
- "key": "string",
- "lineNumber": 0,
- "itemEAN": "string",
- "itemCode": "string",
- "itemCodeSupplier": "string",
- "itemDescription": "string",
- "remarks": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "quantity": 0.1,
- "itemPriceIncludingVat": 0.1,
- "itemPriceExcludingVat": 0.1,
- "vatPercentage": 0.1,
- "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
], - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "costCenter": "string",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "tags": [
- "string"
]
}
], - "key": "string",
- "type": "ORDER",
- "number": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "status": "NEW",
- "state": "string",
- "isBusinessOrder": true,
- "yourReference": "string",
- "paymentReference": "string",
- "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "fulFillmentType": "MERCHANT",
- "warehouse": "string",
- "comment": "string",
- "currency": "AED",
- "shipping": {
- "method": "string",
- "costs": 0.1,
- "costsIncludingVat": 0.1,
- "costsExcludingVat": 0.1,
- "unitPriceIncludingVat": 0.1,
- "unitPriceExcludingVat": 0.1,
- "quantity": 0,
- "vatPercentage": 0.1
}, - "discount": {
- "amount": 0.1,
- "amountExcludingVat": 0.1,
- "amountIncludingVat": 0.1,
- "percentage": 0.1
}, - "buyer": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "delivery": {
- "isPickUpPoint": true,
- "pickUpPointName": "string",
- "pickUpPointFields": [
- {
- "key": "string",
- "value": "string"
}
], - "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "supplier": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "invoicee": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "additionalParties": [
- {
- "type": "COMMISIONEDDEALER",
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
], - "shipFromCountryIso": "string",
- "shipToCountryIso": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "surcharges": [
- {
- "identifier": "string",
- "description": "string",
- "type": "SHIPPING",
- "quantity": 0,
- "vatPercentage": 0.1,
- "vatAmount": 0.1,
- "totalExcludingVat": 0.1,
- "totalIncludingVat": 0.1
}
]
}
}This method is not supported and only provides documentation regarding the models.
{- "header": {
- "source": "string",
- "channel": "string"
}, - "message": {
- "key": "string",
- "shipmentNumber": "string",
- "status": "NEW",
- "orderNumber": "string",
- "orderReference": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "orderKey": "string",
- "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "fulFillmentType": "MERCHANT",
- "comment": "string",
- "buyer": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "delivery": {
- "isPickUpPoint": true,
- "pickUpPointName": "string",
- "pickUpPointFields": [
- {
- "key": "string",
- "value": "string"
}
], - "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "supplier": {
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}, - "additionalParties": [
- {
- "type": "COMMISIONEDDEALER",
- "key": "string",
- "identifier": "string",
- "companyName": "string",
- "vatNumber": "string",
- "chamberOfCommerceNumber": "string",
- "gender": "MALE",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "fullName": "string",
- "email": "string",
- "phone": "string",
- "mobile": "string",
- "website": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
], - "transport": {
- "transporterCode": "string",
- "transporterDescription": "string",
- "trackAndTrace": "string",
- "trackAndTraceUri": "string"
}, - "shipmentLoadCarriers": [
- {
- "loadCarrierEAN": "string",
- "loadCarrierCode": "string",
- "loadCarrierDescription": "string",
- "loadCarrierQuantity": 0.1,
- "loadCarrierType": "string",
- "loadCarrierWeight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "sscc": "string",
- "shipmentLines": [
- {
- "key": "string",
- "lineNumber": 0,
- "itemEAN": "string",
- "itemCode": "string",
- "itemDescription": "string",
- "remarks": "string",
- "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "itemInfo": {
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
], - "dimensions": {
- "length": 0.1,
- "width": 0.1,
- "height": 0.1,
- "unit": "MILLIMETERS"
}, - "volume": {
- "value": 0.1,
- "unit": "MILLILITERS"
}
}, - "quantityDelivered": 0.1,
- "bestBeforeDate": "2019-08-24T14:15:22Z",
- "batchNumber": "string",
- "transport": {
- "transporterCode": "string",
- "transporterDescription": "string",
- "trackAndTrace": "string",
- "trackAndTraceUri": "string"
}, - "deliveryDate": "2019-08-24T14:15:22Z",
- "deliveryDateEarliest": "2019-08-24T14:15:22Z",
- "deliveryDateLatest": "2019-08-24T14:15:22Z",
- "orderNumber": "string",
- "orderReference": "string",
- "orderDate": "2019-08-24T14:15:22Z",
- "orderRemarks": "string",
- "orderLineKey": "string",
- "orderLineRemarks": "string",
- "serialNumbers": [
- "string"
], - "crate": {
- "quantity": 0.1,
- "type": "string",
- "graiNumber": "string",
- "ean": "string",
- "weight": [
- {
- "type": "NET",
- "value": 0.1,
- "unit": "KILOGRAM"
}
]
}
}
]
}
], - "freeFields": [
- {
- "key": "string",
- "value": "string"
}
], - "warehouse": {
- "code": "string",
- "description": "string",
- "identifier": "string",
- "addressType": "DELIVERY",
- "gln": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "additionalAddressInformation": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "countryIso": "string",
- "addressTypes": [
- "DELIVERY"
]
}
}
}