POST api/CheckItems

Returns item validity and pricing from our version of your product catalog

Parameters

* Required
Property Description
Key (String)
* Your API key
ItemDetailsList (List)
* The items to apply to this request.
SKU (String)
* The sku identifier for the item
CustWeightLbs (Decimal)
* The weight of the item in pounds. Not required if your item is already in our catalog
CustLengthInches (Decimal)
* The length of the item in inches. Not required if your item is already in our catalog
CustWidthInches (Decimal)
* The width of the item in inches. Not required if your item is already in our catalog
CustHeightInches (Decimal)
* The height of the item in inches. Not required if your item is already in our catalog
HTSCode (String)
* The international harmonization code of the item. This is not required if the item is already in our catalog and you've allowed a week for us to classify it
CountryOfOrigin (String)
* The country where the item originated. This is typically where the item was last assembled or manufactured. Not required if your item is already in our catalog.
Quantity (Int32)
* The quantity of this item being shipped
OriginalPrice (Decimal)
* The price of the item in your currency
ProductDescription (String)
* A description of the item. Not required if your item is already in our catalog
ValueCompanyCurrency (Decimal)
* The value of the item in your currency. Not required if your item is already in our catalog
CompanyCurrency (String)
The unit representing your company's currency, if different from your account settings
ValueShopperCurrency (Decimal)
The value of the item in the shopper's currency. Not required if the item is already in our catalog
ShopperCurrency (String)
The shopper's currency. The quote response will be converted to this currency
AddressInfo (Consignee)
* The addresses of the sender and recipient. A recipient country and postcode is the minimum required for CheckItems. All fields are required for an actual order.
Shipping (Address)
The shipping address for the parcel
Billing (Address)
The billing address for the parcel
ControlNumber (String)
Russia, Israel, Taiwan, Korea, South Africa, and Brazil require a control number from the consignee. This is also known as a Tax ID.
Id (String)
An identifier for the address if it is meant to be saved the shopper's i-parcel account.
Type (String)
"Billing" or "Shipping". Only required if the shopper is logged in and you want to save this address to their account.
FirstName (String)
* The consignee's first name (not required for Quote)
LastName (String)
* The consignee's last name (not required for Quote)
Street1 (String)
* Line 1 of the consignee's street address
Street2 (String)
* Line 2 of the consignee's street address
PostCode (String)
* The consignee's postal code
City (String)
* The consignee's city
Region (String)
The consignee's province/region/state
CountryCode (String)
* The two-digit country code for the consignee
Email (String)
* The consignee's email address (not required for Quote)
Phone (String)
* The consignee's phone number (not required for Quote)
CurrencyCode (String)
The currency in which to return prices.
DDP (Nullable)
Whether to include duty and tax in the quote (and bill it to your shopper). Default is true.
Insurance (Boolean)
Whether to insure the order.
ServiceLevel (Int32)
The shipping type (115 = i-parcel UPS Select, 112 = i-parcel UPS Express)
OrderReference (String)
An order reference for your own internal tracking.
OtherDiscount (Decimal)
Any discounts you want to apply to the order.
OtherDiscountCurrency (String)
The currency in which you'd like to apply the discount.
TrackingNumber (String)
A pre-supplied tracking number. Must be globally unique to i-parcel. To ensure that, use your account number plus a string that is internally unique to you, plus the country code of the country of export
AlwaysQuote (Boolean)
Return a quote even if there are ineligible items (quote just what's eligible)
ParcelID (Int32)
Deprecated. Always use tracking number instead.
PromoCode (String)
A promotional or coupon code that can have special pricing rules as configured in the Dashboard.
ParcelSize (ParcelSize)
The weight and dimensions of the parcel
ProvidedShipping (Unit)
The shipping being charged to the consignee
TrackByEmail (Boolean)
Opts the consignee into tracking notifications by email
Shipper (MerchantProvidedShipper)
Merchant-Provider Shipper (used by SF)

Request body formats

application/json, text/json

Sample:
{
  "key": "abb57b33-7808-4077-b13b-4438fa5e48d3",
  "ItemDetailsList": [
    {
      "SKU": "ProductABC",
      "CustWeightLbs": 0.0,
      "ValueUSD": 0.0,
      "CustLengthInches": 0.0,
      "CustWidthInches": 0.0,
      "CustHeightInches": 0.0,
      "HTSCode": null,
      "CountryOfOrigin": null,
      "Quantity": 0,
      "OriginalPrice": 0.0,
      "ProductDescription": null,
      "ValueCompanyCurrency": 0.0,
      "CompanyCurrency": null,
      "ValueShopperCurrency": 0.0,
      "ShopperCurrency": null,
      "itemStyle": null,
      "RequestedSKU": null
    },
    {
      "SKU": "ProductXYZ",
      "CustWeightLbs": 0.0,
      "ValueUSD": 0.0,
      "CustLengthInches": 0.0,
      "CustWidthInches": 0.0,
      "CustHeightInches": 0.0,
      "HTSCode": null,
      "CountryOfOrigin": null,
      "Quantity": 0,
      "OriginalPrice": 0.0,
      "ProductDescription": null,
      "ValueCompanyCurrency": 0.0,
      "CompanyCurrency": null,
      "ValueShopperCurrency": 0.0,
      "ShopperCurrency": null,
      "itemStyle": null,
      "RequestedSKU": null
    }
  ],
  "AddressInfo": {
    "Shipping": {
      "Id": null,
      "Type": null,
      "FirstName": "John",
      "LastName": "Smith",
      "Street1": "1 Front St",
      "Street2": "Apt 2B",
      "PostCode": "12345",
      "City": "Sydney",
      "Region": "NSW",
      "CountryCode": "AU",
      "Email": "jsmith@example.com",
      "Phone": "+55 880 909 1234"
    },
    "Billing": {
      "Id": null,
      "Type": null,
      "FirstName": "John",
      "LastName": "Smith",
      "Street1": "1 Front St",
      "Street2": "Apt 2B",
      "PostCode": "12345",
      "City": "Sydney",
      "Region": "NSW",
      "CountryCode": "AU",
      "Email": "jsmith@example.com",
      "Phone": "+55 880 909 1234"
    },
    "ControlNumber": null
  },
  "CurrencyCode": null,
  "DDP": true,
  "Insurance": true,
  "ServiceLevel": 115,
  "OrderReference": null,
  "OtherDiscount": 0.0,
  "OtherDiscountCurrency": null,
  "TrackingNumber": null,
  "AlwaysQuote": false,
  "PromoCode": null,
  "ParcelSize": {
    "WeightLbs": 3.5,
    "LengthInches": 12.0,
    "WidthInches": 6.0,
    "HeightInches": 4.0
  },
  "ProvidedShipping": {
    "Value": 15.5,
    "Label": "USD"
  },
  "TrackByEmail": false
}

application/xml, text/xml

Sample:
<PostCheckoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary">
  <AddressInfo>
    <Billing>
      <City>Sydney</City>
      <CountryCode>AU</CountryCode>
      <Email>jsmith@example.com</Email>
      <FirstName>John</FirstName>
      <Id i:nil="true" />
      <LastName>Smith</LastName>
      <Phone>+55 880 909 1234</Phone>
      <PostCode>12345</PostCode>
      <Region>NSW</Region>
      <Street1>1 Front St</Street1>
      <Street2>Apt 2B</Street2>
      <Type i:nil="true" />
    </Billing>
    <ControlNumber i:nil="true" />
    <FraudOffset>0</FraudOffset>
    <PossibleFraud>false</PossibleFraud>
    <Shipping>
      <City>Sydney</City>
      <CountryCode>AU</CountryCode>
      <Email>jsmith@example.com</Email>
      <FirstName>John</FirstName>
      <Id i:nil="true" />
      <LastName>Smith</LastName>
      <Phone>+55 880 909 1234</Phone>
      <PostCode>12345</PostCode>
      <Region>NSW</Region>
      <Street1>1 Front St</Street1>
      <Street2>Apt 2B</Street2>
      <Type i:nil="true" />
    </Shipping>
  </AddressInfo>
  <AlwaysQuote>false</AlwaysQuote>
  <CreditCardCCV i:nil="true" />
  <CreditCardExpMonth i:nil="true" />
  <CreditCardExpYear i:nil="true" />
  <CreditCardName i:nil="true" />
  <CreditCardNumber i:nil="true" />
  <CurrencyCode i:nil="true" />
  <DDP>true</DDP>
  <Insurance>true</Insurance>
  <ItemDetailsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Repository">
    <d2p1:LineItem>
      <d2p1:CompanyCurrency i:nil="true" />
      <d2p1:CountryOfOrigin i:nil="true" />
      <d2p1:CustHeightInches>0</d2p1:CustHeightInches>
      <d2p1:CustLengthInches>0</d2p1:CustLengthInches>
      <d2p1:CustWeightLbs>0</d2p1:CustWeightLbs>
      <d2p1:CustWidthInches>0</d2p1:CustWidthInches>
      <d2p1:HTSCode i:nil="true" />
      <d2p1:OriginalPrice>0</d2p1:OriginalPrice>
      <d2p1:ProductDescription i:nil="true" />
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RequestedSKU i:nil="true" />
      <d2p1:SKU>ProductABC</d2p1:SKU>
      <d2p1:ShopperCurrency i:nil="true" />
      <d2p1:ValueCompanyCurrency>0</d2p1:ValueCompanyCurrency>
      <d2p1:ValueShopperCurrency>0</d2p1:ValueShopperCurrency>
      <d2p1:ValueUSD>0</d2p1:ValueUSD>
      <d2p1:itemStyle i:nil="true" />
    </d2p1:LineItem>
    <d2p1:LineItem>
      <d2p1:CompanyCurrency i:nil="true" />
      <d2p1:CountryOfOrigin i:nil="true" />
      <d2p1:CustHeightInches>0</d2p1:CustHeightInches>
      <d2p1:CustLengthInches>0</d2p1:CustLengthInches>
      <d2p1:CustWeightLbs>0</d2p1:CustWeightLbs>
      <d2p1:CustWidthInches>0</d2p1:CustWidthInches>
      <d2p1:HTSCode i:nil="true" />
      <d2p1:OriginalPrice>0</d2p1:OriginalPrice>
      <d2p1:ProductDescription i:nil="true" />
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RequestedSKU i:nil="true" />
      <d2p1:SKU>ProductXYZ</d2p1:SKU>
      <d2p1:ShopperCurrency i:nil="true" />
      <d2p1:ValueCompanyCurrency>0</d2p1:ValueCompanyCurrency>
      <d2p1:ValueShopperCurrency>0</d2p1:ValueShopperCurrency>
      <d2p1:ValueUSD>0</d2p1:ValueUSD>
      <d2p1:itemStyle i:nil="true" />
    </d2p1:LineItem>
  </ItemDetailsList>
  <OrderReference i:nil="true" />
  <OtherDiscount>0</OtherDiscount>
  <OtherDiscountCurrency i:nil="true" />
  <ParcelID>123456</ParcelID>
  <ParcelSize>
    <HeightInches>4</HeightInches>
    <LengthInches>12</LengthInches>
    <WeightLbs>3.5</WeightLbs>
    <WidthInches>6</WidthInches>
  </ParcelSize>
  <PaymentMethod i:nil="true" />
  <PromoCode i:nil="true" />
  <ProvidedShipping xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Conversion">
    <d2p1:Label>USD</d2p1:Label>
    <d2p1:Value>15.50</d2p1:Value>
  </ProvidedShipping>
  <SFAddressId i:nil="true" />
  <SFUserFlag>false</SFUserFlag>
  <ServiceLevel>115</ServiceLevel>
  <SessionID i:nil="true" />
  <Shipper i:nil="true" />
  <ShippingMarkupFixed xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Conversion" i:nil="true" />
  <TrackByEmail>false</TrackByEmail>
  <TrackingNumber i:nil="true" />
  <key>abb57b33-7808-4077-b13b-4438fa5e48d3</key>
</PostCheckoutRequest>

Response Information

The HTS code, weight, etc...

Response body formats

application/json, text/json

Sample:
{
  "ItemDetailsList": [
    {
      "SKU": "ProductABC",
      "CustWeightLbs": 0.0,
      "ValueUSD": 0.0,
      "CustLengthInches": 0.0,
      "CustWidthInches": 0.0,
      "CustHeightInches": 0.0,
      "HTSCode": null,
      "CountryOfOrigin": null,
      "Quantity": 0,
      "OriginalPrice": 0.0,
      "ProductDescription": null,
      "ValueCompanyCurrency": 12.34,
      "CompanyCurrency": null,
      "ValueShopperCurrency": 0.0,
      "ShopperCurrency": null,
      "itemStyle": null,
      "RequestedSKU": null
    },
    {
      "SKU": "ProductXYZ",
      "CustWeightLbs": 0.0,
      "ValueUSD": 0.0,
      "CustLengthInches": 0.0,
      "CustWidthInches": 0.0,
      "CustHeightInches": 0.0,
      "HTSCode": null,
      "CountryOfOrigin": null,
      "Quantity": 0,
      "OriginalPrice": 0.0,
      "ProductDescription": null,
      "ValueCompanyCurrency": 32.1,
      "CompanyCurrency": null,
      "ValueShopperCurrency": 0.0,
      "ShopperCurrency": null,
      "itemStyle": null,
      "RequestedSKU": null
    }
  ]
}

application/xml, text/xml

Sample:
<PostCheckItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary">
  <ItemDetailsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Repository">
    <d2p1:LineItem>
      <d2p1:CompanyCurrency i:nil="true" />
      <d2p1:CountryOfOrigin i:nil="true" />
      <d2p1:CustHeightInches>0</d2p1:CustHeightInches>
      <d2p1:CustLengthInches>0</d2p1:CustLengthInches>
      <d2p1:CustWeightLbs>0</d2p1:CustWeightLbs>
      <d2p1:CustWidthInches>0</d2p1:CustWidthInches>
      <d2p1:HTSCode i:nil="true" />
      <d2p1:OriginalPrice>0</d2p1:OriginalPrice>
      <d2p1:ProductDescription i:nil="true" />
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RequestedSKU i:nil="true" />
      <d2p1:SKU>ProductABC</d2p1:SKU>
      <d2p1:ShopperCurrency i:nil="true" />
      <d2p1:ValueCompanyCurrency>12.34</d2p1:ValueCompanyCurrency>
      <d2p1:ValueShopperCurrency>0</d2p1:ValueShopperCurrency>
      <d2p1:ValueUSD>0</d2p1:ValueUSD>
      <d2p1:itemStyle i:nil="true" />
    </d2p1:LineItem>
    <d2p1:LineItem>
      <d2p1:CompanyCurrency i:nil="true" />
      <d2p1:CountryOfOrigin i:nil="true" />
      <d2p1:CustHeightInches>0</d2p1:CustHeightInches>
      <d2p1:CustLengthInches>0</d2p1:CustLengthInches>
      <d2p1:CustWeightLbs>0</d2p1:CustWeightLbs>
      <d2p1:CustWidthInches>0</d2p1:CustWidthInches>
      <d2p1:HTSCode i:nil="true" />
      <d2p1:OriginalPrice>0</d2p1:OriginalPrice>
      <d2p1:ProductDescription i:nil="true" />
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RequestedSKU i:nil="true" />
      <d2p1:SKU>ProductXYZ</d2p1:SKU>
      <d2p1:ShopperCurrency i:nil="true" />
      <d2p1:ValueCompanyCurrency>32.1</d2p1:ValueCompanyCurrency>
      <d2p1:ValueShopperCurrency>0</d2p1:ValueShopperCurrency>
      <d2p1:ValueUSD>0</d2p1:ValueUSD>
      <d2p1:itemStyle i:nil="true" />
    </d2p1:LineItem>
  </ItemDetailsList>
</PostCheckItemsResponse>