Concept - Order Submission Framework
Introduction
Order Submission is a special form of the order export where the data is sent in JSON format to a configurable external service.
One usage is the export of orders to the BI Data Hub.
References
General Workflow of Order Submission
The order submission consists of the following steps (see diagram above):
- The order export process is triggered by an external entity. This can either be a customer that creates an order (in case an immediate export is configured), or a scheduled job that periodically exports recent orders.
- ICM looks up the configured export service and sends the
OrderBOto the service. - The
OrderBOis transformed into anOrderROthat can be parsed by the microservice/backend's REST API. - The
OrderROis transferred to the microservice/backend. - An immediate answer (Accepted) is returned from the microservice/backend to the managed service. At the same time, an asynchronous process is triggered that further processes the order data (e.g., export to the backend in case of a microservice), see 8.
- The managed service notifies ICM that the order submission has been started. This may trigger additional actions (e.g., change order status) on the ICM side depending on the export configuration.
- A response is returned to the caller.
- The order data is further processed by the service it was submitted to.
- After all the data has been submitted, a message is sent back to a REST resource in ICM stating whether the order was successfully exported. The resource resides in the
callbackUri, specified in theOrderROsent in step 4 (see Data Format). The actual URL has to be resolved via Eureka service registry as the endpoint is not part of the normal REST API and also not accessible via the Web Adapter. - The order export status is updated accordingly.
The implementation of steps 9 and 10 is not mandatory. It is only necessary if you want the status to be updated by your service after the order has been processed. Else, you can simply configure automatic order & line item status updates, see Concept - Order Export Framework, which take effect as soon as the data is exported to your service.
Setup
The setup process is described using BI Data Hub as an example. Instead of BI Data Hub, you may use any other service that provides the required endpoint and supports the general workflow for order submission.
Data Format
The data is mapped to a JSON format.
Example Order mapped to JSON
{
"order" : {
"header": {
"documentInfo": {
"orderUrn": "urn:order:ICM:inSPIRED:inTRONICS:00000002",
"documentNo": "00000002",
"store": "inTRONICS",
"currency": "USD",
"locale": "en_US",
"customerReferenceId": "RE201700002786598"
},
"processInfo": {
"status": "CANCELLED",
"creationDate": "2001-07-04T12:08:56.235-07:00"
}
},
"totals": {
"grandTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"shippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedItemTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedShippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"giftingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"surchargeTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"bucketShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"orderValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"orderShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"valueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"shippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"salesTaxTotalsByTaxRate": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"shippingTaxTotalsByTaxRate": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"taxTotalsByTaxRate": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
},
"invoiceToAddress": {
"addressLine1": "Sample Street 1a",
"city": "Sample City",
"countryCode": "US",
"postalCode": "77093",
"contact": {
"firstName": "Peter",
"lastName": "Sampleman",
"title": "Mr",
"aristocraticTitle": "Lord",
"honorific": "PhD",
"jobTitle": "Procurement Lead",
"secondName": "Max",
"secondLastName": "Rodriguez",
"phoneHome": "+49 (3641) 123456",
"phoneMobile": "+49 (165) 5673123",
"phoneBusiness": "+49 (3641) 50-0",
"phoneBusinessDirect": "3479",
"fax": "+49 (3641) 50-1344",
"email": "peter.sampleman@intershop.de"
},
"addressType": "POSTAL",
"addressLine2": "Northern University",
"addressLine3": "Floor 3",
"postBox": "143",
"mainDivision": "Texas",
"subDivision": "Harris County",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"buckets": [
{
"shipToAddress": {
"addressLine1": "Sample Street 1a",
"city": "Sample City",
"countryCode": "US",
"postalCode": "77093",
"contact": {
"firstName": "Peter",
"lastName": "Sampleman",
"title": "Mr",
"aristocraticTitle": "Lord",
"honorific": "PhD",
"jobTitle": "Procurement Lead",
"secondName": "Max",
"secondLastName": "Rodriguez",
"phoneHome": "+49 (3641) 123456",
"phoneMobile": "+49 (165) 5673123",
"phoneBusiness": "+49 (3641) 50-0",
"phoneBusinessDirect": "3479",
"fax": "+49 (3641) 50-1344",
"email": "peter.sampleman@intershop.de"
},
"addressType": "POSTAL",
"addressLine2": "Northern University",
"addressLine3": "Floor 3",
"postBox": "143",
"mainDivision": "Texas",
"subDivision": "Harris County",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"shippingMethod": {
"id": "STD_GROUND",
"name": "STANDARD GROUND",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"items": [
{
"lineItem": {
"position": 0,
"quantity": {
"unit": "PIEC",
"value": 10.99
},
"desiredDeliveryDate": "2018-12-20"
},
"itemProduct": {
"id": "j2EKAB1UKmsAAAFdoB4H2qdH",
"sku": "5079747",
"name": "InTRONICS IS-25Y Portable",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
],
"isGiftCard": true,
"isDigital": false
},
"itemPricing": {
"salesPricing": {
"price": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"singleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemValueDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"discountedSingleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedSingleBasePriceRemainder": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedPrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
},
"shippingPricing": {
"shippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemShippingDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
},
"surcharges": {
"itemSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemImportSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"distributedBucketSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"distributedBucketSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"surchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
},
"itemGiftWrap": {
"product": {
"id": "j2EKAB1UKmsAAAFdoB4H2qdH",
"sku": "5079747",
"name": "InTRONICS IS-25Y Portable",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"itemPricing": {
"salesPricing": {
"price": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"singleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemValueDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"discountedSingleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedSingleBasePriceRemainder": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedPrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
},
"shippingPricing": {
"shippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemShippingDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
},
"surcharges": {
"itemSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemImportSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"distributedBucketSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"distributedBucketSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"surchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
}
},
"itemGiftMessage": {
"product": {
"id": "j2EKAB1UKmsAAAFdoB4H2qdH",
"sku": "5079747",
"name": "InTRONICS IS-25Y Portable",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"itemPricing": {
"salesPricing": {
"price": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"singleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemValueDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"discountedSingleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedSingleBasePriceRemainder": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedPrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
},
"shippingPricing": {
"shippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemShippingDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
},
"surcharges": {
"itemSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemImportSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"distributedBucketSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"distributedBucketSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"surchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
},
"message": "Happy birthday!",
"from": "Patricia",
"to": "Peter"
},
"itemWarranty": {
"product": {
"id": "j2EKAB1UKmsAAAFdoB4H2qdH",
"sku": "5079747",
"name": "InTRONICS IS-25Y Portable",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"itemPricing": {
"salesPricing": {
"price": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"singleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemValueDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemValueDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"discountedSingleBasePrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedSingleBasePriceRemainder": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"discountedPrice": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
},
"shippingPricing": {
"shippingTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"itemShippingDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"itemShippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
},
"surcharges": {
"itemSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemImportSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"itemSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"distributedBucketSurcharges": [
{
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"name": "Fridge Box",
"description": "Needs a fridge box for shipping.",
"taxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
]
}
],
"distributedBucketSurchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"surchargesTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
}
},
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
}
],
"bucketTotals": {
"shippingDiscountsTotal": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
},
"shippingInstructions": "Handle with care!",
"bucketDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
]
}
],
"payments": [
{
"id": "92YKAABCZtIAAAFb_KwtfPFU",
"limitedTender": true,
"paymentBaseAmount": {
"currency": "USD",
"value": 10.99
},
"paymentTotalAmount": {
"currency": "USD",
"value": 10.99
},
"status": "CREATED",
"paymentCost": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
},
"paymentTaxes": [
{
"calculatedTax": {
"currency": "USD",
"value": 10.99
},
"effectiveTaxRate": 0,
"situs": "DESTINATION",
"jurisdiction": {
"id": "CANADA",
"level": "COUNTRY"
},
"nonTaxableAmount": {
"currency": "USD",
"value": 10.99
},
"taxableAmount": {
"currency": "USD",
"value": 10.99
}
}
],
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
}
],
"customer": {
"customerNo": "OilCorp",
"customerUrn": "urn:customer:ICM:inSPIRED:inTOOLS:OilCorp",
"externalCustomerNo": "000123456",
"externalCustomerUrn": "urn:customer:MSDynamics365:MyCorp:0033459",
"customerTypeId": "PRIVATE",
"companyName1": "OilCorp Ltd.",
"companyName2": "OilCorp Corporate Headquarters",
"taxationId": "9XX-78-XXXX",
"roles": [
{
"role": "BUYER",
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
}
],
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"orderDiscounts": {
"orderValueDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
],
"orderShippingDiscounts": [
{
"id": "92YKAM6dZtIAAAFb_KwtfPFU",
"promotionType": "Order Value Off",
"description": "20 USD Order discount",
"code": "Intershop",
"amount": {
"net": {
"currency": "USD",
"value": 10.99
},
"gross": {
"currency": "USD",
"value": 10.99
},
"tax": {
"currency": "USD",
"value": 10.99
}
}
}
]
},
"additionalAttributes": [
{
"name": "someAttribute",
"value": "true",
"type": "BOOLEAN"
}
]
},
"callbackUri" : "service://<service-identifier>/order/sites/<site>/applications/<application>/orders/<urn>"
}
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.