POST v1/api/Standard/Labelling/OrderDetails
SG01 - Post Inline Order Details. Hosted by the EShopWorld Labelling System, this call will prime the labelling System with order details.
Request Information
URI Parameters
None.
Body Parameters
esw.Common.Model.Published.Labelling.OrderDetailsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Type |
The type of request being sent. |
esw.Common.Model.Published.Labelling.OrderDetailsRequestType |
None. |
| OrderId |
eShopWorld OrderId. Required: Yes |
integer |
None. |
| OrderArticles |
Order Article details for the Order. Required: Yes |
Collection of esw.Common.Model.Published.Labelling.OrderArticle |
None. |
| OrderCurrency |
The ISO 4217 (3 letter) Order Payment Currency. Required: Yes |
string |
None. |
| DeliveryOption |
The Brand's Order delivery option. Required: Yes |
string |
None. |
| ConsigneeDetails |
Shipping Name and Address details. Required: Yes |
esw.Common.Model.Published.Labelling.ConsigneeDetails |
None. |
| BillingDetails |
Billing Name and Address details. Required: No |
esw.Common.Model.Published.Labelling.OrderBillingDetails |
None. |
| OrderCurrencyExponent |
The Order Payment Currency Exponent (The number of digits after a decimal point.). Required: Yes |
integer |
None. |
| SettlementCurrency |
3 Letter ISO Settlement Currency |
string |
None. |
| SettlementCurrencyExponent |
The number of decimal places allocated for this Currency. |
integer |
None. |
| SettlementFxRate |
The fx rate to use to convert Currency to SettlementCurrency. |
decimal number |
None. |
| PaymentMethodId |
The Payment Method. |
integer |
None. |
| PaymentAmount |
The payment amount that customer paid. |
decimal number |
None. |
| StoreId |
The StoreId for Pudo. |
string |
None. |
| CarrierServiceRouteId |
The CarrierServiceRouteId for shipping routes. |
string |
None. |
| DeliveryLocationCode |
The DeliveryLocationCode for Pudo. |
string |
None. |
| EswCarrierIdentifier |
The EswCarrierIdentifier from Pudo. |
string |
None. |
| DeliveryTypeId |
The DeliveryTypeId (ie: Home, Ship to Store, Pudo) |
byte |
None. |
| OrderHoldStatusId |
Order Hold Status Id |
integer |
None. |
| SortCode |
The Sort Code for Pudo. |
string |
None. |
| EvoPaymentMethodCode |
New raw PaymentMethodCode from payments |
string |
None. |
| BrandCode |
The Brand's unique identifier in the eShopWorld system. Required: Yes |
string |
None. |
| OrderNumber |
The Brand's OrderNumber / Cart Identifier Required: Yes |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Type": 0,
"OrderId": 1,
"OrderArticles": [
{
"OrderArticleId": 1,
"ProductCode": "sample string 2",
"OrderItemLineId": 3,
"Price": 4.0,
"TaxesCharge": 5.0,
"ShippingCharge": 6.0,
"IsCancelled": true,
"MaterialNumber": "sample string 8",
"Size": "sample string 9",
"Description": "sample string 10",
"Name": "sample string 11",
"HsCode": "sample string 12",
"FullFillmentDistCenterId": 1
},
{
"OrderArticleId": 1,
"ProductCode": "sample string 2",
"OrderItemLineId": 3,
"Price": 4.0,
"TaxesCharge": 5.0,
"ShippingCharge": 6.0,
"IsCancelled": true,
"MaterialNumber": "sample string 8",
"Size": "sample string 9",
"Description": "sample string 10",
"Name": "sample string 11",
"HsCode": "sample string 12",
"FullFillmentDistCenterId": 1
}
],
"OrderCurrency": "sample string 2",
"DeliveryOption": "sample string 3",
"ConsigneeDetails": {
"Address3": "sample string 1",
"StoreName": "sample string 2",
"PersonalInfo": {
"PersonalId": "sample string 1",
"AdditionalData1": "sample string 2",
"AdditionalData2": "sample string 3",
"AdditionalData3": "sample string 4",
"AdditionalData4": "sample string 5",
"AdditionalData5": "sample string 6"
},
"NickName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Gender": 0,
"Email": "sample string 6",
"Telephone": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"City": "sample string 10",
"Country": "sample string 11",
"POBox": "sample string 12",
"PostalCode": "sample string 13",
"Region": "sample string 14",
"Unit": "sample string 15"
},
"BillingDetails": {
"Address3": "sample string 1",
"NickName": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Gender": 0,
"Email": "sample string 5",
"Telephone": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"City": "sample string 9",
"Country": "sample string 10",
"PostalCode": "sample string 11",
"Region": "sample string 12",
"Unit": "sample string 13"
},
"OrderCurrencyExponent": 4,
"SettlementCurrency": "sample string 5",
"SettlementCurrencyExponent": 6,
"SettlementFxRate": 7.0,
"PaymentMethodId": 1,
"PaymentAmount": 8.0,
"StoreId": "sample string 9",
"CarrierServiceRouteId": "sample string 10",
"DeliveryLocationCode": "sample string 11",
"EswCarrierIdentifier": "sample string 12",
"DeliveryTypeId": 64,
"OrderHoldStatusId": 1,
"SortCode": "sample string 13",
"EvoPaymentMethodCode": "sample string 14",
"BrandCode": "sample string 15",
"OrderNumber": "sample string 16"
}
application/xml, text/xml
Sample:
<OrderDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
<BrandCode>sample string 15</BrandCode>
<OrderNumber>sample string 16</OrderNumber>
<BillingDetails>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<City>sample string 9</City>
<Country>sample string 10</Country>
<Email>sample string 5</Email>
<FirstName>sample string 3</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 4</LastName>
<NickName>sample string 2</NickName>
<PostalCode>sample string 11</PostalCode>
<Region>sample string 12</Region>
<Telephone>sample string 6</Telephone>
<Unit>sample string 13</Unit>
<Address3>sample string 1</Address3>
</BillingDetails>
<CarrierServiceRouteId>sample string 10</CarrierServiceRouteId>
<ConsigneeDetails>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<City>sample string 10</City>
<Country>sample string 11</Country>
<Email>sample string 6</Email>
<FirstName>sample string 4</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 5</LastName>
<NickName>sample string 3</NickName>
<POBox>sample string 12</POBox>
<PostalCode>sample string 13</PostalCode>
<Region>sample string 14</Region>
<Telephone>sample string 7</Telephone>
<Unit>sample string 15</Unit>
<Address3>sample string 1</Address3>
<PersonalInfo>
<AdditionalData1>sample string 2</AdditionalData1>
<AdditionalData2>sample string 3</AdditionalData2>
<AdditionalData3>sample string 4</AdditionalData3>
<AdditionalData4>sample string 5</AdditionalData4>
<AdditionalData5>sample string 6</AdditionalData5>
<PersonalId>sample string 1</PersonalId>
</PersonalInfo>
<StoreName>sample string 2</StoreName>
</ConsigneeDetails>
<DeliveryLocationCode>sample string 11</DeliveryLocationCode>
<DeliveryOption>sample string 3</DeliveryOption>
<DeliveryTypeId>64</DeliveryTypeId>
<EswCarrierIdentifier>sample string 12</EswCarrierIdentifier>
<EvoPaymentMethodCode>sample string 14</EvoPaymentMethodCode>
<OrderArticles>
<OrderArticle>
<Description>sample string 10</Description>
<FullFillmentDistCenterId>1</FullFillmentDistCenterId>
<HsCode>sample string 12</HsCode>
<IsCancelled>true</IsCancelled>
<MaterialNumber>sample string 8</MaterialNumber>
<Name>sample string 11</Name>
<OrderArticleId>1</OrderArticleId>
<OrderItemLineId>3</OrderItemLineId>
<Price>4</Price>
<ProductCode>sample string 2</ProductCode>
<ShippingCharge>6</ShippingCharge>
<Size>sample string 9</Size>
<TaxesCharge>5</TaxesCharge>
</OrderArticle>
<OrderArticle>
<Description>sample string 10</Description>
<FullFillmentDistCenterId>1</FullFillmentDistCenterId>
<HsCode>sample string 12</HsCode>
<IsCancelled>true</IsCancelled>
<MaterialNumber>sample string 8</MaterialNumber>
<Name>sample string 11</Name>
<OrderArticleId>1</OrderArticleId>
<OrderItemLineId>3</OrderItemLineId>
<Price>4</Price>
<ProductCode>sample string 2</ProductCode>
<ShippingCharge>6</ShippingCharge>
<Size>sample string 9</Size>
<TaxesCharge>5</TaxesCharge>
</OrderArticle>
</OrderArticles>
<OrderCurrency>sample string 2</OrderCurrency>
<OrderCurrencyExponent>4</OrderCurrencyExponent>
<OrderHoldStatusId>1</OrderHoldStatusId>
<OrderId>1</OrderId>
<PaymentAmount>8</PaymentAmount>
<PaymentMethodId>1</PaymentMethodId>
<SettlementCurrency>sample string 5</SettlementCurrency>
<SettlementCurrencyExponent>6</SettlementCurrencyExponent>
<SettlementFxRate>7</SettlementFxRate>
<SortCode>sample string 13</SortCode>
<StoreId>sample string 9</StoreId>
<Type>Add</Type>
</OrderDetailsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
esw.Common.Model.Published.Labelling.OrderDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | esw.Common.Model.Published.Labelling.OrderDetailsStatus |
None. |
|
| StatusMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"StatusMessage": "sample string 1"
}
application/xml, text/xml
Sample:
<OrderDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts"> <Status xmlns="http://schemas.datacontract.org/2004/07/esw.Common.Model.Published.BaseResponse">Success</Status> <StatusMessage xmlns="http://schemas.datacontract.org/2004/07/esw.Common.Model.Published.BaseResponse">sample string 1</StatusMessage> </OrderDetailsResponse>