POST v1/api/CalculateInternationalCharges

Calculates preliminary International Charges due for a Nike customer.

Request Information

URI Parameters

None.

Body Parameters

An object containing CalculateInternationalChargesRequest details for eShopWorld to process.

esw.Common.Model.Published.CalculateInternationalCharges.Nike.NikeCalculateInternationalChargesRequest
NameDescriptionTypeAdditional information
PromotionCodes

The Promotion Codes entered at Cart to apply to the Calculation. Required: No

 Collection of string

None.
Header

Controlling parameters for the Retailer PreOrder request to eShopWorld. Required: Yes.

 esw.Common.Model.Published.CalculateInternationalCharges.CalculateInternationalChargesRequestHeader

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 not populated, the calculation will be based on the cheapest delivery service level available. Required: No

 string

None.
ShippingDetails

The minimum shipping address details required for calculating international charges. Required: Yes

 esw.Common.Model.Published.CalculateInternationalCharges.CalculateInternationalChargesShippingDetails

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. This will be used for formatting & localization of relevant response items. Required: No

 string

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: 
{
  "PromotionCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Header": {
    "BrandCode": "sample string 1"
  },
  "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 1",
  "PaymentCurrencyCode": "sample string 2",
  "ServiceLevel": "sample string 3",
  "ShippingDetails": {
    "Country": "sample string 1",
    "Region": "sample string 2"
  },
  "ClientCultureLanguage": "sample string 4",
  "ExpansionNameValuePairs": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<NikeCalculateInternationalChargesRequest 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 1</BaseCurrencyCode>
  <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>
  <ClientCultureLanguage xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 4</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>
  <Header xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
    <BrandCode>sample string 1</BrandCode>
  </Header>
  <PaymentCurrencyCode xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 2</PaymentCurrencyCode>
  <ServiceLevel xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">sample string 3</ServiceLevel>
  <ShippingDetails xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
    <Country>sample string 1</Country>
    <Region>sample string 2</Region>
  </ShippingDetails>
  <PromotionCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PromotionCodes>
</NikeCalculateInternationalChargesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'esw.Common.Model.Published.CalculateInternationalCharges.Nike.NikeCalculateInternationalChargesRequest'.

Response Information

Resource Description

An object containing the eShopWorld response object to Nike containing relevant charges for the brand to display at Cart level.

esw.Common.Model.Published.CalculateInternationalCharges.Nike.NikeCalculateInternationalChargesResponse
NameDescriptionTypeAdditional information
DutyAndTaxTotal

The calculated Duty And Tax total.

 decimal number

None.
PaymentCurrencyCode

The 3 letter ISO code identifier for the billing/payment currency.

 string

None.
FxRateId

The FxRateId used for the calculation on the eShopWorld system. To ensure that the same calculation is arrived at when the cart is transferred to the eShopWorld Checkout, this value should be used in the PreOrder request during Cart to Checkout handover. Note: This value will be null if the BaseCurrencyCode is equal to the PaymentCurrencyCode in the request.

 integer

None.
Transport

The transport charge in the billing/payment currency if applicable.

 decimal number

None.
HandlingFee

The eShopWorld admin/handling fee if applicable.

 decimal number

None.
ValidServiceLevels

A List of the valid service levels available for the CalculateInternationalCharges request.

 Collection of esw.Common.Model.Published.CalculateInternationalCharges.CalculateInternationalChargesServiceLevel

None.
InternationalServiceFee

The international service fee applied by eShopWorld, as agreed by Nike.

 decimal number

None.
ActualTransportApplied

The actual transport charge to the customer in the billing/payment currency after promotions have been applied.

 decimal number

None.
Status

esw.Common.Model.Published.CalculateInternationalCharges.Nike.NikeCalculateInternationalChargesStatus

None.
StatusMessage

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "DutyAndTaxTotal": 1.0,
  "PaymentCurrencyCode": "sample string 2",
  "FxRateId": 1,
  "Transport": 3.0,
  "HandlingFee": 4.0,
  "ValidServiceLevels": [
    {
      "ServiceLevel": "sample string 1",
      "LocalizedServiceLevelDescription": "sample string 2",
      "IsUsedInCalculation": true
    },
    {
      "ServiceLevel": "sample string 1",
      "LocalizedServiceLevelDescription": "sample string 2",
      "IsUsedInCalculation": true
    }
  ],
  "InternationalServiceFee": 1.0,
  "ActualTransportApplied": 5.0,
  "Status": 0,
  "StatusMessage": "sample string 6"
}

application/xml, text/xml

Sample: 
<NikeCalculateInternationalChargesResponse 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 6</StatusMessage>
  <ActualTransportApplied>5</ActualTransportApplied>
  <DutyAndTaxTotal>1</DutyAndTaxTotal>
  <FxRateId>1</FxRateId>
  <HandlingFee>4</HandlingFee>
  <InternationalServiceFee>1</InternationalServiceFee>
  <PaymentCurrencyCode>sample string 2</PaymentCurrencyCode>
  <Transport>3</Transport>
  <ValidServiceLevels xmlns:d2p1="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
    <d2p1:CalculateInternationalChargesServiceLevel>
      <d2p1:IsUsedInCalculation>true</d2p1:IsUsedInCalculation>
      <d2p1:LocalizedServiceLevelDescription>sample string 2</d2p1:LocalizedServiceLevelDescription>
      <d2p1:ServiceLevel>sample string 1</d2p1:ServiceLevel>
    </d2p1:CalculateInternationalChargesServiceLevel>
    <d2p1:CalculateInternationalChargesServiceLevel>
      <d2p1:IsUsedInCalculation>true</d2p1:IsUsedInCalculation>
      <d2p1:LocalizedServiceLevelDescription>sample string 2</d2p1:LocalizedServiceLevelDescription>
      <d2p1:ServiceLevel>sample string 1</d2p1:ServiceLevel>
    </d2p1:CalculateInternationalChargesServiceLevel>
  </ValidServiceLevels>
</NikeCalculateInternationalChargesResponse>