POST v1/api/PreOrder
Nike's PreOrder details for eShopWorld to process.
Request Information
URI Parameters
None.
Body Parameters
A object containing PreOrder details for eShopWorld to process.
esw.Common.Model.Published.PreOrder.Nike.NikePreOrderDetailsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Controlling parameters for the Nike PreOrder request to eShopWorld. Required: Yes. |
esw.Common.Model.Published.PreOrder.Nike.NikePreOrderDetailsRequestHeader |
None. |
| OrderNumber |
The Brand's OrderNumber / Cart Identifier Required: Yes |
string |
None. |
| BrandCode |
The Brand's unique identifier in the eShopWorld system. Required: Yes |
string |
None. |
| CartItems |
A list of CartItem objects detailing cart item level details. Required: Yes |
Collection of esw.Common.Model.Published.Common.CartItem |
None. |
| BaseCurrencyCode |
The 3 letter ISO code identifier for the base currency. If not provided, the default value in the eShopWorld system for the Brand will be used. Required: No |
string |
None. |
| PaymentCurrencyCode |
The 3 letter ISO code identifier for the billing/payment currency. If not provided, the default value in the eShopWorld system for the Brand will be used. Required: No |
string |
None. |
| ServiceLevel |
The Brand's pre-selected delivery service code - Mapped in the eShopWorld system. If applicable, the Checkout will default to this Service level. Required: No |
string |
None. |
| ShippingDetails |
A list of potential shipping addresses for this cart. e.g. A logged in user may have a number of pre-defined addresses. Required: No |
Collection of esw.Common.Model.Published.Common.ShippingDetails |
None. |
| BillingDetails |
A list of potential billing addresses for this cart. e.g. A logged in user may have a number of pre-defined addresses. Required: No |
Collection of esw.Common.Model.Published.Common.BillingDetails |
None. |
| ClientCultureLanguage |
The Client culture and language in the format xx-XX (e.g. en-US for English - United States). If not provided, the default value in the eShopWorld system will be used. Required: No |
string |
None. |
| FxRateId |
The FxRateId to sync to on the eShopWorld system. If in use, this value needs to match the latest value in the eShopWorld system OR be less than x hours old. Required: No |
integer |
None. |
| ExpansionNameValuePairs |
A collection of name - value pairs for future expansion with a brand. Required: No. |
Collection of esw.Common.Model.Published.Common.ExpansionNameValuePair |
None. |
Request Formats
application/json, text/json
Sample:
{
"Header": {
"CustomerCountry": "sample string 1",
"SessionAndInventoryTimeoutInMinutes": 2,
"BuyersRemorseTimeInMinutes": 1,
"PromotionCodes": [
"sample string 1",
"sample string 2"
],
"LoginDetails": {
"ProfileId": "sample string 1",
"Username": "sample string 2",
"DisplayName": "sample string 3",
"VisitorId": "sample string 4"
},
"RegisterWithNike": true,
"DOMSData": {
"OriginOfOrder": "sample string 1",
"Locale": "sample string 2",
"CreationIpAddress": "sample string 3",
"UserAgent": "sample string 4",
"EnterpriseCode": "sample string 5",
"CartItems": [
{
"Quantity": 1,
"Product": {
"StyleNumber": "sample string 1",
"ColorNumber": "sample string 2",
"ColorDescription": "sample string 3",
"Size": "sample string 4",
"DisplaySize": "sample string 5",
"ProductCode": "sample string 6",
"MetricId": "sample string 7",
"CatalogRefId": "sample string 8",
"UPC": "sample string 9",
"AdditionalDays": 10.0,
"Type": "sample string 11",
"DisplayName": "sample string 12",
"ListPrice": 13.0,
"AmountLocal": 14.0,
"CountryOfOrigin": "sample string 15",
"ReservationId": "sample string 16",
"ProductId": "sample string 17",
"DiscountPerUnit": 18.0,
"Price": 19.0,
"LeftRightId": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"PreBuildId": "sample string 20",
"PathName": "sample string 21",
"OnSale": "sample string 22"
},
"OrderDelay": "2025-04-04T04:48:39.623079+00:00",
"EstimatedDeliveryDate": "2025-04-04T04:48:39.623079+00:00"
},
{
"Quantity": 1,
"Product": {
"StyleNumber": "sample string 1",
"ColorNumber": "sample string 2",
"ColorDescription": "sample string 3",
"Size": "sample string 4",
"DisplaySize": "sample string 5",
"ProductCode": "sample string 6",
"MetricId": "sample string 7",
"CatalogRefId": "sample string 8",
"UPC": "sample string 9",
"AdditionalDays": 10.0,
"Type": "sample string 11",
"DisplayName": "sample string 12",
"ListPrice": 13.0,
"AmountLocal": 14.0,
"CountryOfOrigin": "sample string 15",
"ReservationId": "sample string 16",
"ProductId": "sample string 17",
"DiscountPerUnit": 18.0,
"Price": 19.0,
"LeftRightId": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"PreBuildId": "sample string 20",
"PathName": "sample string 21",
"OnSale": "sample string 22"
},
"OrderDelay": "2025-04-04T04:48:39.623079+00:00",
"EstimatedDeliveryDate": "2025-04-04T04:48:39.623079+00:00"
}
]
},
"PayPalClicked": true,
"ProductLaunchOrder": true
},
"OrderNumber": "sample string 1",
"BrandCode": "sample string 2",
"CartItems": [
{
"Quantity": 1,
"Product": {
"ProductCode": "sample string 1",
"Description": "sample string 2",
"Price": 1.0,
"ImageUrl": "sample string 3",
"CountryOfOrigin": "sample string 4",
"StyleNumber": "sample string 5",
"ColorNumber": "sample string 6",
"Size": "sample string 7",
"AdditionalItemDetails": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
"EstimatedDeliveryDate": "0001-01-01T00:00:00"
},
{
"Quantity": 1,
"Product": {
"ProductCode": "sample string 1",
"Description": "sample string 2",
"Price": 1.0,
"ImageUrl": "sample string 3",
"CountryOfOrigin": "sample string 4",
"StyleNumber": "sample string 5",
"ColorNumber": "sample string 6",
"Size": "sample string 7",
"AdditionalItemDetails": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
"EstimatedDeliveryDate": "0001-01-01T00:00:00"
}
],
"BaseCurrencyCode": "sample string 3",
"PaymentCurrencyCode": "sample string 4",
"ServiceLevel": "sample string 5",
"ShippingDetails": [
{
"NickName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Gender": 0,
"Email": "sample string 4",
"Telephone": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"City": "sample string 8",
"Country": "sample string 9",
"POBox": "sample string 10",
"PostalCode": "sample string 11",
"Region": "sample string 12",
"Unit": "sample string 13"
},
{
"NickName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Gender": 0,
"Email": "sample string 4",
"Telephone": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"City": "sample string 8",
"Country": "sample string 9",
"POBox": "sample string 10",
"PostalCode": "sample string 11",
"Region": "sample string 12",
"Unit": "sample string 13"
}
],
"BillingDetails": [
{
"NickName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Gender": 0,
"Email": "sample string 4",
"Telephone": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"City": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Region": "sample string 11",
"Unit": "sample string 12"
},
{
"NickName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Gender": 0,
"Email": "sample string 4",
"Telephone": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"City": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Region": "sample string 11",
"Unit": "sample string 12"
}
],
"ClientCultureLanguage": "sample string 6",
"FxRateId": 1,
"ExpansionNameValuePairs": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<NikePreOrderDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.Contracts">
<BaseCurrencyCode xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 3</BaseCurrencyCode>
<BillingDetails xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
<BillingDetails>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<Country>sample string 9</Country>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 3</LastName>
<NickName>sample string 1</NickName>
<PostalCode>sample string 10</PostalCode>
<Region>sample string 11</Region>
<Telephone>sample string 5</Telephone>
<Unit>sample string 12</Unit>
</BillingDetails>
<BillingDetails>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<Country>sample string 9</Country>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 3</LastName>
<NickName>sample string 1</NickName>
<PostalCode>sample string 10</PostalCode>
<Region>sample string 11</Region>
<Telephone>sample string 5</Telephone>
<Unit>sample string 12</Unit>
</BillingDetails>
</BillingDetails>
<BrandCode xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 2</BrandCode>
<CartItems xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
<CartItem>
<EstimatedDeliveryDate>0001-01-01T00:00:00.0000000</EstimatedDeliveryDate>
<Product>
<AdditionalItemDetails>
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
</AdditionalItemDetails>
<ColorNumber>sample string 6</ColorNumber>
<CountryOfOrigin>sample string 4</CountryOfOrigin>
<Description>sample string 2</Description>
<ImageUrl>sample string 3</ImageUrl>
<Price>1</Price>
<ProductCode>sample string 1</ProductCode>
<Size>sample string 7</Size>
<StyleNumber>sample string 5</StyleNumber>
</Product>
<Quantity>1</Quantity>
</CartItem>
<CartItem>
<EstimatedDeliveryDate>0001-01-01T00:00:00.0000000</EstimatedDeliveryDate>
<Product>
<AdditionalItemDetails>
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
</AdditionalItemDetails>
<ColorNumber>sample string 6</ColorNumber>
<CountryOfOrigin>sample string 4</CountryOfOrigin>
<Description>sample string 2</Description>
<ImageUrl>sample string 3</ImageUrl>
<Price>1</Price>
<ProductCode>sample string 1</ProductCode>
<Size>sample string 7</Size>
<StyleNumber>sample string 5</StyleNumber>
</Product>
<Quantity>1</Quantity>
</CartItem>
</CartItems>
<ClientCartId xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 1</ClientCartId>
<ClientCultureLanguage xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 6</ClientCultureLanguage>
<ExpansionNameValuePairs xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
<BrandExpansionNameValuePair>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</BrandExpansionNameValuePair>
</ExpansionNameValuePairs>
<FxRateId xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">1</FxRateId>
<PaymentCurrencyCode xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 4</PaymentCurrencyCode>
<ServiceLevel xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 5</ServiceLevel>
<ShippingDetails xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
<ShippingDetails>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<Country>sample string 9</Country>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 3</LastName>
<NickName>sample string 1</NickName>
<POBox>sample string 10</POBox>
<PostalCode>sample string 11</PostalCode>
<Region>sample string 12</Region>
<Telephone>sample string 5</Telephone>
<Unit>sample string 13</Unit>
</ShippingDetails>
<ShippingDetails>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<Country>sample string 9</Country>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Gender>Unused</Gender>
<LastName>sample string 3</LastName>
<NickName>sample string 1</NickName>
<POBox>sample string 10</POBox>
<PostalCode>sample string 11</PostalCode>
<Region>sample string 12</Region>
<Telephone>sample string 5</Telephone>
<Unit>sample string 13</Unit>
</ShippingDetails>
</ShippingDetails>
<Header>
<BuyersRemorseTimeInMinutes>1</BuyersRemorseTimeInMinutes>
<CustomerCountry>sample string 1</CustomerCountry>
<DOMSData>
<CartItems>
<NikeDomsCartitem>
<EstimatedDeliveryDate>2025-04-04T04:48:39.623079+00:00</EstimatedDeliveryDate>
<OrderDelay>2025-04-04T04:48:39.623079+00:00</OrderDelay>
<Product>
<AdditionalDays>10</AdditionalDays>
<AmountLocal>14</AmountLocal>
<CatalogRefId>sample string 8</CatalogRefId>
<ColorDescription>sample string 3</ColorDescription>
<ColorNumber>sample string 2</ColorNumber>
<CountryOfOrigin>sample string 15</CountryOfOrigin>
<DiscountPerUnit>18</DiscountPerUnit>
<DisplayName>sample string 12</DisplayName>
<DisplaySize>sample string 5</DisplaySize>
<LeftRightId xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>sample string 2</d7p1:Value>
</d7p1:KeyValueOfstringstring>
<d7p1:KeyValueOfstringstring>
<d7p1:Key>sample string 3</d7p1:Key>
<d7p1:Value>sample string 4</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</LeftRightId>
<ListPrice>13</ListPrice>
<MetricId>sample string 7</MetricId>
<OnSale>sample string 22</OnSale>
<PathName>sample string 21</PathName>
<PreBuildId>sample string 20</PreBuildId>
<Price>19</Price>
<ProductCode>sample string 6</ProductCode>
<ProductId>sample string 17</ProductId>
<ReservationId>sample string 16</ReservationId>
<Size>sample string 4</Size>
<StyleNumber>sample string 1</StyleNumber>
<Type>sample string 11</Type>
<UPC>sample string 9</UPC>
</Product>
<Quantity>1</Quantity>
</NikeDomsCartitem>
<NikeDomsCartitem>
<EstimatedDeliveryDate>2025-04-04T04:48:39.623079+00:00</EstimatedDeliveryDate>
<OrderDelay>2025-04-04T04:48:39.623079+00:00</OrderDelay>
<Product>
<AdditionalDays>10</AdditionalDays>
<AmountLocal>14</AmountLocal>
<CatalogRefId>sample string 8</CatalogRefId>
<ColorDescription>sample string 3</ColorDescription>
<ColorNumber>sample string 2</ColorNumber>
<CountryOfOrigin>sample string 15</CountryOfOrigin>
<DiscountPerUnit>18</DiscountPerUnit>
<DisplayName>sample string 12</DisplayName>
<DisplaySize>sample string 5</DisplaySize>
<LeftRightId xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>sample string 2</d7p1:Value>
</d7p1:KeyValueOfstringstring>
<d7p1:KeyValueOfstringstring>
<d7p1:Key>sample string 3</d7p1:Key>
<d7p1:Value>sample string 4</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</LeftRightId>
<ListPrice>13</ListPrice>
<MetricId>sample string 7</MetricId>
<OnSale>sample string 22</OnSale>
<PathName>sample string 21</PathName>
<PreBuildId>sample string 20</PreBuildId>
<Price>19</Price>
<ProductCode>sample string 6</ProductCode>
<ProductId>sample string 17</ProductId>
<ReservationId>sample string 16</ReservationId>
<Size>sample string 4</Size>
<StyleNumber>sample string 1</StyleNumber>
<Type>sample string 11</Type>
<UPC>sample string 9</UPC>
</Product>
<Quantity>1</Quantity>
</NikeDomsCartitem>
</CartItems>
<CreationIpAddress>sample string 3</CreationIpAddress>
<EnterpriseCode>sample string 5</EnterpriseCode>
<Locale>sample string 2</Locale>
<OriginOfOrder>sample string 1</OriginOfOrder>
<UserAgent>sample string 4</UserAgent>
</DOMSData>
<LoginDetails>
<ProfileId>sample string 1</ProfileId>
<Username>sample string 2</Username>
<DisplayName>sample string 3</DisplayName>
<VisitorId>sample string 4</VisitorId>
</LoginDetails>
<PayPalClicked>true</PayPalClicked>
<ProductLaunchOrder>true</ProductLaunchOrder>
<PromotionCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</PromotionCodes>
<RegisterWithNike>true</RegisterWithNike>
<SessionAndInventoryTimeoutInMinutes>2</SessionAndInventoryTimeoutInMinutes>
</Header>
</NikePreOrderDetailsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
An object containing the eShopWorld object containing PreOrderCode and relevant Checkout url for the brand to redirect too.
esw.Common.Model.Published.PreOrder.Nike.NikePreOrderDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PreOrderCode |
The PreOrder Code generated in the eshopWorld system. |
string |
None. |
| OrderNumber |
The Order Number/CartId passed in the request by the Retailer. |
string |
None. |
| RedirectUrl |
The Checkout / Paypal Url to redirect to for this Pre Order |
string |
None. |
| Status | esw.Common.Model.Published.PreOrder.Nike.NikePreOrderStatus |
None. |
|
| StatusMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PreOrderCode": "sample string 1",
"OrderNumber": "sample string 2",
"RedirectUrl": "sample string 3",
"Status": 0,
"StatusMessage": "sample string 4"
}
application/xml, text/xml
Sample:
<NikePreOrderDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.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 4</StatusMessage> <OrderNumber>sample string 2</OrderNumber> <PreOrderCode>sample string 1</PreOrderCode> <RedirectUrl>sample string 3</RedirectUrl> </NikePreOrderDetailsResponse>