Create Order
The Create Order operation creates a new order. The operation is not truly synchronous. The Order Service call is still asynchronous.
For a step-by-step guide to this API, see the following tutorial pages:
- How to Build an Order Create Request
- OrderCreateRequest OrderItem Examples
- OrderCreateRequest Payment Examples
- OrderCreateRequest Shipping Examples
- Adding Shipping Information to the Order
- Submitting the Order
- Handling Failed Order Submission
URI Summary
|
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
|---|---|---|---|---|---|---|
|
Create order |
POST |
/vM.m/stores/STOREID/orders/create.format |
/v1.0/stores/ABCD/orders/create.xml |
Create new order. |
Yes |
Order-Service-Create-1.0.xsd |
URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:
https://apg.radial.com/v1.0/proxyname/storecode/function
You should have received the applicable information for proxyname, storecode, and function from your Radial representative.
Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.
Schemas
- Checkout-Datatypes-1.0.xsd
- Checkout-Service-Fault-1.0.xsd
- Order-Datatypes-Common-1.0.xsd
- Order-Service-Create-1.0.xsd
- Payment-Datatypes-1.0.xsd
- Payment-Datatypes-CurrencyCode-1.0.xsd
Business Rules
To ensure successful processing, adhere to the following business rules when preparing Order Create Request messages.
Order ID
Values for PaymentSessionId and webOrderId must match in the following places:
- Payment > Payments > PaymentContext > CreditCard
<Order webOrderId="00081o222871496"> <PaymentSessionId>00081o222871496</PaymentSessionId>
- Payment > Payments > PaymentContext > PayPal
<Order webOrderId="00081o220875708"> <PaymentSessionId>00081o220875708</PaymentSessionId>
PayPal Payment
If PayPal is being used to pay for an order, the <PaymentAccountUniqueId> element must be set to PAYPAL , and the isToken attribute must be set to "false":
<PaymentAccountUniqueId isToken="false">PAYPAL</PaymentAccountUniqueId>
Fraud Processing - Required Data
For fraud processing and successful order completion, the following highlighted fields must contain non-empty values:
<BrowserData>
<HostName>. . .</HostName>
<IPAddress>. . .</IPAddress>
<SessionId>. . .</SessionId>
<UserAgent>. . .</UserAgent>
<Connection>. . .</Connection>
<Cookies>. . .</Cookies>
<JavascriptData>. . .</JavascriptData>
<Referrer>. . .</Referrer>
<HTTPAcceptData>
<ContentTypes>. . .</ContentTypes>
<Encoding>. . .</Encoding>
<Language>. . .</Language>
<CharSet>. . .</CharSet>
</HTTPAcceptData>
</BrowserData> Fraud Processing - Suggested Data
For fraud processing, the following highlighted fields should contain non-empty values if the data is available in the HTTP request message that the webstore receives:
<BrowserData>
<HostName>. . .</HostName>
<IPAddress>. . .</IPAddress>
<SessionId>. . .</SessionId>
<UserAgent>. . .</UserAgent>
<Connection>. . .</Connection>
<Cookies>. . .</Cookies>
<JavascriptData>. . .</JavascriptData>
<Referrer>. . .</Referrer>
<HTTPAcceptData>
<ContentTypes>. . .</ContentTypes>
<Encoding>. . .</Encoding>
<Language>. . .</Language>
<CharSet>. . .</CharSet>
</HTTPAcceptData>
</BrowserData>
Fraud Processing - PayPal
If PayPal is used to pay for an order, the following highlighted fields must contain non-empty values for fraud processing:
<OrderCreateRequest requestId=". . ." xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<Order customerOrderId=". . .">
. . .
</Order>
<Context>
<BrowserData>
. . .
</BrowserData>
<TdlOrderTimestamp>. . .</TdlOrderTimestamp>
<PayPalPayerInfo>
<PayPalPayerID>UNIQUE-CUSTOMER-PAYPAL-ID</PayPalPayerID>
<PayPalPayerStatus>verified</PayPalPayerStatus>
<PayPalAddressStatus>Confirmed</PayPalAddressStatus>
</PayPalPayerInfo>
</Context>
</OrderCreateRequest>
Values for the PayPalPayerInfo elements are obtained from the PayPalGetExpressCheckoutReply as follows:
| Element | Source of Value |
|---|---|
| PayPalPayerInfo > PayPalPayerID | PayPalGetExpressCheckoutReply > PayerId |
| PayPalPayerInfo > PayPalPayerStatus | PayPalGetExpressCheckoutReply > PayerStatus |
| PayPalPayerInfo > PayPalAddressStatus | PayPalGetExpressCheckoutReply > BillingAddress > AddressStatus |
Fraud Processing - Virtual Gift Cards
If a virtual gift card (VGC) is used to pay for an order, the following elements must meet special data rules for fraud processing.
| Element | Requirement |
|---|---|
| OrderItem > Pricing > Merchandise > TaxData > TaxClass | The value must be 61900. |
| OrderItem > Gifting > GiftCard > Message | Valid to and from names must be provided. |
| Destinations > Email >PersonName | The sender's name must be provided. |
| Shipping > Destinations > Email | The reference must match the email implemented in Shipping > ShipGroups > DestinationTarget. |
<OrderItems>
<OrderItem id="vgc_1" . . .>
. . .
<Pricing>
<Merchandise>
. . .
<TaxData>
<TaxClass>61900</TaxClass>
. . .
</TaxData>
. . .
</Merchandise>
<Shipping>
. . .
</Shipping>
</Pricing>
. . .
<Gifting>
<GiftCard>
<Message>
<To>. . .</To>
<From>. . .</From>
<Message>. . .</Message>
</Message>
</GiftCard>
</Gifting>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup . . .>
<DestinationTarget ref="email_dest1"/>
<OrderItems>
<Item ref="vgc_1"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id=". . .">
. . .
</MailingAddress>
<Email id="email_dest1">
<EmailAddress>. . .</EmailAddress>
<PersonName>
<LastName>. . .</LastName>
<FirstName>. . .</FirstName>
</PersonName>
</Email>
</Destinations>
</Shipping>
Credit Card Authorization
APPROVED and TIMEOUT are the only values supported for the Payment > Payments > CreditCard > Authorization > ResponseCode element. This element is case-sensitive; the value must be delivered in all caps.
Copy this code sample.
<Payment>
<BillingAddress ref=". . ."/>
<Payments>
<CreditCard>
<PaymentContext>
. . .
</PaymentContext>
<CreateTimeStamp>. . .</CreateTimeStamp>
<Amount>. . .</Amount>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>. . .</BankAuthorizationCode>
<CVV2ResponseCode>. . .</CVV2ResponseCode>
<AVSResponseCode>. . .</AVSResponseCode>
<AmountAuthorized>. . .</AmountAuthorized>
</Authorization>
<ExpirationDate>. . .</ExpirationDate>
</CreditCard>
</Payments>
</Payment>
American Express Authorization
If American Express is used to pay for an order, additional authorization is required. If Payment > Payments > CreditCard > PaymentContext > TenderType equals AM (American Express) and Payment > Payments > CreditCard > Authorization > ResponseCode equals APPROVED, then the following highlighted fields must have values.
Copy this code sample.
<Payment>
<BillingAddress ref=". . ."/>
<Payments>
<CreditCard>
<PaymentContext>
<OrderAppId>. . .</OrderAppId>
<PaymentSessionId>. . .</PaymentSessionId>
<TenderType>AM</TenderType>
<PaymentAccountUniqueId isToken="true">. . .</PaymentAccountUniqueId>
</PaymentContext>
<CreateTimeStamp>. . .</CreateTimeStamp>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>. . .</BankAuthorizationCode>
<CVV2ResponseCode>. . .</CVV2ResponseCode>
<AVSResponseCode>. . .</AVSResponseCode>
<PhoneResponseCode>U</PhoneResponseCode>
<NameResponseCode>U</NameResponseCode>
<EmailResponseCode>U</EmailResponseCode>
<AmountAuthorized>. . .</AmountAuthorized>
</Authorization>
<ExpirationDate>. . .</ExpirationDate>
</CreditCard>
</Payments>
</Payment>
TaxData
If tax information is provided in an order, the following highlighted TaxData elements and attributes must have non-empty values. Missing values can cause downstream problems that prevent processing and fulfilling the order. Tax information used in Order Create should match the tax information in the Tax Quote API for the same order.
Copy this code sample.
<TaxData>
<TaxClass>. . .</TaxClass>
<Taxes>
<Tax taxType=". . ." taxability=". . .">
<Situs>. . .</Situs>
<Jurisdiction JurisdictionId=". . ." JurisdictionLevel=". . .">. . .</Jurisdiction>
<Imposition ImpositionType=". . .">. . .</Imposition>
<EffectiveRate>. . .</EffectiveRate>
<TaxableAmount>. . .</TaxableAmount>
<CalculatedTax>. . .</CalculatedTax>
</Tax>
</Taxes>
</TaxData> TaxHeader
The value of the TaxHeader element depends on whether tax information is provided in an order.
If tax information is not provided in an order, the TaxHeader > Error element must be set to true in the following places:
- OrderItems > OrderItem > Pricing > Merchandise > TaxData
- OrderItems > OrderItem > Pricing > Shipping > TaxData
<TaxHeader>
<Error>true</Error>
</TaxHeader>
If tax information is provided in an order, the TaxHeader > Error element must be set to false in the following places:
- OrderItems > OrderItem > Pricing > Merchandise > TaxData
- OrderItems > OrderItem > Pricing > Shipping > TaxData
A value of true would cause OMS to recalculate tax duty and fee charges that were already provided.
Copy this code sample.
<TaxData>
<TaxClass>. . .</TaxClass>
<Taxes>
<Tax taxType=". . ." taxability=". . .">
<Situs>. . .</Situs>
<Jurisdiction JurisdictionId=". . ." JurisdictionLevel=". . .">. . .</Jurisdiction>
<Imposition ImpositionType=". . .">. . .</Imposition>
<EffectiveRate>. . .</EffectiveRate>
<TaxableAmount>. . .</TaxableAmount>
<CalculatedTax>. . .</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<TaxHeader>
<Error>false</Error>
</TaxHeader> TenderType Values
The following TenderType elements can only use valid values that are supported by the Payment API.
-
Payment > Payments > CreditCard > PaymentContext > TenderType
<Payment>
<BillingAddress ref=". . ."/>
<Payments>
<CreditCard>
<PaymentContext>
<OrderAppId>. . .</OrderAppId>
<PaymentSessionId>. . .</PaymentSessionId>
<TenderType>AM</TenderType>
<PaymentAccountUniqueId isToken="true">. . .</PaymentAccountUniqueId>
</PaymentContext>
<CreateTimeStamp>. . .</CreateTimeStamp>
<Authorization>
. . .
</CreditCard>
</Payments>
</Payment>
-
Payment > Payments > PayPal > PaymentContext > TenderType
<Payment>
<BillingAddress ref=". . ."/>
<Payments>
<PayPal>
<Amount>. . .</Amount>
<AmountAuthorized>. . .</AmountAuthorized>
<PaymentContext>
<OrderAppId>. . .</OrderAppId>
<PaymentSessionId>. . .</PaymentSessionId>
<TenderType>PY</TenderType>
<PaymentAccountUniqueId isToken="false">PAYPAL</PaymentAccountUniqueId>
</PaymentContext>
<CreateTimeStamp>. . .</CreateTimeStamp>
<Authorization>
<ResponseCode>. . .</ResponseCode>
</Authorization>
</PayPal>
</Payments>
</Payment>
The following are examples of supported values.
| Tender Type | Description |
|---|---|
| VC | Visa |
| MC | MasterCard |
| OGC | Online gift card |
| SM | Maestro UK |
| SO | Solo UK |
| BH | Blackhawk gift card (provider specific) |
| SP | SVS gift card (provider specific) |
| PY | PayPal |
| BL | Bill me later |
| CVS | CVS |
| COD | COD |
| BR | Prepaid |
Payment Amount
The sum of all amounts in an order (such as merchandise, shipping, and promotional discount amounts) must be calculated and confirmed to match the amount supplied in the payment information.
<OrderItems>
<OrderItem id=". . ." webLineId="1">
<ItemId>. . .</ItemId>
<Quantity>1</Quantity>
. . .
<Pricing>
<Merchandise>
<Amount>69.96</Amount>
<PromotionalDiscounts>
<Discount>
<Id>. . .</Id>
<Amount>0</Amount>
. . .
</Discount>
<Discount>
<Id>. . .</Id>
<Amount>19.99</Amount>
. . .
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>. . .</TaxClass>
<Taxes>
<Tax taxType=". . ." taxability=". . .">
. . .
<CalculatedTax>2.54</CalculatedTax>
</Tax>
<Tax taxType=". . ." taxability=". . .">
. . .
<CalculatedTax>0.60</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>79.96</UnitPrice>
</Merchandise>
<Shipping>
<Amount>6.95</Amount>
<TaxData>
<Taxes>
<Tax taxType=". . .">
. . .
<CalculatedTax>0.29</CalculatedTax>
</Tax>
<Tax taxType=". . .">
. . .
<CalculatedTax>0.07</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
. . .
</OrderItem>
</OrderItems>
. . .
<Payment>
<BillingAddress ref=". . ."/>
<Payments>
<CreditCard>
<PaymentContext>
. . .
</PaymentContext>
<CreateTimeStamp>. . .</CreateTimeStamp>
<Amount>60.42</Amount>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
. . .
<AmountAuthorized>60.42</AmountAuthorized>
</Authorization>
<ExpirationDate>. . .</ExpirationDate>
</CreditCard>
</Payments>
</Payment> Promotion Requirements
The following rules apply for PromotionalDiscounts > Discount > Id:
- This element is mandatory.
- The value cannot contain special characters (such as $). Special characters cause errors when the order is processed.
- The value cannot exceed 40 characters due to database restrictions in OMS (YFS_CHARGE_LINE).
- The value must be unique for each OrderItems > OrderItem. If a value is duplicated for an OrderItem, order processing fails because of a unique constraint violation.
The PromotionalDiscounts > Discount > EffectType element must have one of the following supported values:
- Product Discount
- Shipping Discount
- ShippingTargetPriceDiscount
- FreeGiftDiscount
- Item Discount
- OrderValueOffDiscount
- OrderPercentageOffDiscount
- Order Discount
- ShippingPercentageOffDiscount
- ItemValueOffDiscount
- ItemTargetPriceDiscount
- ItemPercentageOffDiscount
- ShippingValueOffDiscount
- HiddenGiftDiscount
<OrderItems>
<OrderItem id="item_1" . . .>
. . .
<Pricing>
<Merchandise>
. . .
<PromotionalDiscounts>
<Discount>
<Id>FORTY-CHARACTER-MAXIMUM</Id>
<Amount>8.00</Amount>
<Description>SOME-DESCRIPTION</Description>
<EffectType>NEEDS-ENUMERATION</EffectType>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
. . .
</Taxes>
</TaxData>
</Discount>
</PromotionalDiscounts>
. . .
</Merchandise>
. . .
</Pricing>
. . .
</OrderItem>
</OrderItems>Examples
New order with standard shipping
OrderCreateRequest receives OrderCreateResponse.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
orderType="##ORDER_TYPE##" requestId="##REQUEST_ID##" >
<Order levelOfService="##LEVEL_OF_SERVICE##" customerOrderId="##ORDER_ID##">
<Customer customerId="##CUSTOMER_ID_PREFIX##1234056789">
<Name>
. . .
</Name>
<EmailAddress>##EMAIL##</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
</Customer>
<CreateTime>##CURRENT_DATE_TIME##</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="1">
<ItemId>##ITEM1_ID##</ItemId>
<Quantity>##QUANTITY1##</Quantity>
. . .
</OrderItem>
</OrderItems>
<Shipping>
. . .
</Shipping>
<Payment>
. . .
</Payment>
. . .
</Order>
<Context>
. . .
</Context>
</OrderCreateRequest>Response XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<ResponseStatus>Success</ResponseStatus>
</OrderCreateResponse>New order with multiple ISPU items with proxy pickup
OrderCreateRequest receives OrderCreateResponse.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns = "http://api.gsicommerce.com/schema/checkout/1.0" requestId = "554432">
<Order customerOrderId = "00026ISPU1049">
<Customer customerId = "nullISPUORDER">
<Name>
. . .
</Name>
<EmailAddress>earemanda@examplemail.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
. . .
</Customer>
<CreateTime>2010-02-25T14:04:33</CreateTime>
<OrderItems>
<OrderItem id = "item_1" webLineId = "1" taxAndDutyDisplay = "INDIVIDUAL">
<ItemId>21-885641255428</ItemId>
<Quantity>1</Quantity>
. . .
<ShippingMethod>ISPU</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>01-4152</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>STORE_PICK_UP</FulfillmentChannel>
<ProxyPickupDetails>
<FirstName>Proxy</FirstName>
<LastName>Pickup</LastName>
<Email>myEmail@testemail.com</Email>
<Phone>1234567890</Phone>
<Address>
. . .
</Address>
<Relationship>Self</Relationship>
</ProxyPickupDetails>
. . .
</OrderItem>
<OrderItem id = "item_2" webLineId = "2" taxAndDutyDisplay = "INDIVIDUAL">
<ItemId>21-822342540231</ItemId>
<Quantity>1</Quantity>
. . .
<ShippingMethod>ISPU</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>01-4373</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>STORE_PICK_UP</FulfillmentChannel>
<ProxyPickupDetails>
<FirstName>Proxy2</FirstName>
<LastName>Pickup2</LastName>
<Email>myEmail2@testemail.com</Email>
<Phone>1234567890</Phone>
<Address>
. . .
</Address>
<Relationship>None</Relationship>
</ProxyPickupDetails>
. . .
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup id = "shipgroup_1" chargeType = "FLAT">
<DestinationTarget ref = "dest_2"/>
<OrderItems>
<Item ref = "item_1"/>
</OrderItems>
</ShipGroup>
<ShipGroup id = "shipgroup_2" chargeType = "FLAT">
<DestinationTarget ref = "dest_3"/>
<OrderItems>
<Item ref = "item_2"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id = "dest_1">
. . .
</MailingAddress>
<StoreLocation id = "dest_2">
<StoreCode>01-4152</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreLocation>
<StoreLocation id = "dest_3">
<StoreCode>01-4373</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreLocation>
</Destinations>
</Shipping>
<Payment>
. . .
</Payment>
. . .
</Order>
<Context>
. . .
</Context>
</OrderCreateRequest>Response XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<ResponseStatus>Success</ResponseStatus>
</OrderCreateResponse>New order with multiple STS items with proxy pickup
OrderCreateRequest receives OrderCreateResponse.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns = "http://api.gsicommerce.com/schema/checkout/1.0" requestId = "554432">
<Order customerOrderId = "00026STS5023">
<Customer customerId = "nullSTSORDER">
<Name>
. . .
</Name>
<EmailAddress>example@testemail.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
. . .
</Customer>
<CreateTime>2010-02-25T14:04:33</CreateTime>
<OrderItems>
<OrderItem id = "item_1" webLineId = "1" taxAndDutyDisplay = "INDIVIDUAL">
<ItemId>21-822342540231</ItemId>
<Quantity>1</Quantity>
. . .
<ShippingMethod>STS_EXP</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>01-4129</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>SHIP_TO_STORE</FulfillmentChannel>
<ProxyPickupDetails>
<FirstName>Proxy</FirstName>
<LastName>Pickup</LastName>
<Email>myEmail@testemail.com</Email>
<Phone>1234567890</Phone>
<Address>
. . .
</Address>
<Relationship>Self</Relationship>
</ProxyPickupDetails>
. . .
</OrderItem>
<OrderItem id = "item_2" webLineId = "2" taxAndDutyDisplay = "INDIVIDUAL">
<ItemId>21-885641282349</ItemId>
<Quantity>1</Quantity>
. . .
<ShippingMethod>STS_EXP</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>01-4373</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>SHIP_TO_STORE</FulfillmentChannel>
<ProxyPickupDetails>
<FirstName>Proxy2</FirstName>
<LastName>Pickup2</LastName>
<Email>myEmail2@testemail.com</Email>
<Phone>1234567890</Phone>
<Address>
. . .
</Address>
<Relationship>None</Relationship>
</ProxyPickupDetails>
. . .
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup id = "shipgroup_1" chargeType = "FLAT">
<DestinationTarget ref = "dest_2"/>
<OrderItems>
<Item ref = "item_1"/>
</OrderItems>
</ShipGroup>
<ShipGroup id = "shipgroup_2" chargeType = "FLAT">
<DestinationTarget ref = "dest_3"/>
<OrderItems>
<Item ref = "item_2"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id = "dest_1">
. . .
</MailingAddress>
<StoreLocation id = "dest_2">
<StoreCode>01-4152</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreLocation>
<StoreLocation id = "dest_3">
<StoreCode>01-4373</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreLocation>
</Destinations>
</Shipping>
<Payment>
. . .
</Payment>
. . .
</Order>
<Context>
. . .
</Context>
</OrderCreateRequest>Response XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<ResponseStatus>Success</ResponseStatus>
</OrderCreateResponse>New order with one ISPU reservation item
OrderCreateRequest receives an OrderCreateResponse.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns = "http://api.gsicommerce.com/schema/checkout/1.0" requestId = "554432">
<Order customerOrderId = "00026ISPURES1035">
<Customer customerId = "nullRESORDER">
<Name>
. . .
</Name>
<EmailAddress>example@testemail.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
. . .
</Customer>
<CreateTime>2010-02-25T14:04:33</CreateTime>
<OrderItems>
<OrderItem id = "item_1" webLineId = "1" taxAndDutyDisplay = "INDIVIDUAL">
<ItemId>21-885641255534</ItemId>
<Quantity>1</Quantity>
. . .
<ShippingMethod>ISPU</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>01-4129</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>STORE_RESERVATION</FulfillmentChannel>
. . .
<ReservationId>12345</ReservationId>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup id = "shipgroup_1" chargeType = "FLAT">
<DestinationTarget ref = "dest_2"/>
<OrderItems>
<Item ref = "item_1"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id = "dest_1">
. . .
</MailingAddress>
<StoreLocation id = "dest_2">
<StoreCode>01-0101</StoreCode>
<StoreName>Test Store</StoreName>
<Address>
. . .
</Address>
</StoreLocation>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref = "dest_1"/>
<Payments>
<ReservationPayment>NO_PAYMENT</ReservationPayment>
</Payments>
</Payment>
. . .
</Order>
<Context>
. . .
</Context>
</OrderCreateRequest>Response XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<ResponseStatus>Success</ResponseStatus>
</OrderCreateResponse>New order eligible for Associate Delivery
The IsAssociateDeliveryEligible element indicates whether an item can be delivered by a store associate. The applicable values are true and false.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="ISO-8859-1"?>
<OrderCreateRequest xmlns="http://schema.gspt.net/Order/1.0" orderType="SALES">
<Order webOrderId="0002685852538153" levelOfService="REGULAR">
<SourceId type="STORE">TMSUS</SourceId>
<Customer customerId="null0889413722">
<Name>
<LastName>Doyle</LastName>
<FirstName>Richard</FirstName>
</Name>
<EmailAddress>RIT_E2E_2001_ISPU@dashboard.gsi</EmailAddress>
<CustomerTaxId>12345</CustomerTaxId>
<TaxExemptFlag>true</TaxExemptFlag>
</Customer>
<CreateTime>2018-02-27T03:44:18</CreateTime>
<OrderItems>
<OrderItem id="item_2" webLineId="2">
<ItemId>21-ISPUProd02</ItemId>
<Quantity>3</Quantity>
<Description>
<Description>Red Floral Dress</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>76800</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction JurisdictionId="24354" JurisdictionLevel="STATE">NEW YORK</Jurisdiction>
<Imposition ImpositionType="General Sales and Use Tax">Sales and Compensating Use Tax</Imposition>
<EffectiveRate>0.04</EffectiveRate>
<TaxableAmount>114.0</TaxableAmount>
<CalculatedTax>4.56</CalculatedTax>
</Tax>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction JurisdictionId="25353" JurisdictionLevel="CITY">NEW YORK</Jurisdiction>
<Imposition ImpositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.045</EffectiveRate>
<TaxableAmount>114.0</TaxableAmount>
<CalculatedTax>5.13</CalculatedTax>
</Tax>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction JurisdictionId="79774" JurisdictionLevel="DISTRICT">METROPOLITAN COMMUTER
TRANSPORTATION DISTRICT</Jurisdiction>
<Imposition ImpositionType="General Sales and Use Tax">Metropolitan Commuter
Transportation District</Imposition>
<EffectiveRate>0.00375</EffectiveRate>
<TaxableAmount>114.0</TaxableAmount>
<CalculatedTax>0.43</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
</Pricing>
<ShippingMethod displayText="Store Pickup">ISPU</ShippingMethod>
<StoreFrontDetails>
<StoreFrontLocation>
<StoreCode>TMS_NA-Store1</StoreCode>
<StoreName>PITTSBURGH-SOUTHSIDE SC</StoreName>
<StoreEmail>4373wm1@rsonline.gsicommerce.com</StoreEmail>
<Address>
<Line1>SOUTHSIDE SHOPPING CTR</Line1>
<Line2>2000 WHARTON ST STE A</Line2>
<Line3>addy3</Line3>
<City>PITTSBURGH</City>
<MainDivisionCode>PA</MainDivisionCode>
<CountryCode>US</CountryCode>
<PostalCode>15203</PostalCode>
</Address>
</StoreFrontLocation>
</StoreFrontDetails>
<FulfillmentChannel>STORE_PICK_UP</FulfillmentChannel>
<EstimatedDeliveryDate>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<VendorId>Vendor1</VendorId>
<VendorName>Broad Street's vendor</VendorName>
<SerialNumber>123</SerialNumber>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
<Attribute>
<Key>PVAR_DESC_COLOR</Key>
<Value>Brown</Value>
</Attribute>
<Attribute>
<Key>PVAR_LABEL_COLOR</Key>
<Value>color</Value>
</Attribute>
<Attribute>
<Key>PVAR_CODE_SIZE</Key>
<Value>6-M</Value>
</Attribute>
<Attribute>
<Key>PVAR_DESC_SIZE</Key>
<Value>6-M</Value>
</Attribute>
<Attribute>
<Key>PVAR_LABEL_SIZE</Key>
<Value>Size</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002685852538153</ReservationId>
<IsAssociateDeliveryEligible>true</IsAssociateDeliveryEligible>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup chargeType="WEIGHTBASED" id="shipgroup_1">
<DestinationTarget ref="address_0065"/>
<OrderItems>
<Item ref="item_1"/>
<Item ref="item_2"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="billing_1">
<PersonName>
<LastName>Doyle</LastName>
<FirstName>Richard</FirstName>
</PersonName>
<Address>
<Line1>801 Hat Trick Avenue</Line1>
<City>Eveleth</City>
<MainDivisionCode>MN</MainDivisionCode>
<CountryCode>US</CountryCode>
</Address>
<Phone>111-111-1111</Phone>
</MailingAddress>
<StoreLocation id="address_0065">
<StoreCode>TMS_NA-Store1</StoreCode>
<StoreName>PITTSBURGH-SOUTHSIDE SC</StoreName>
<StoreEmail>4373wm1@rsonline.gsicommerce.com</StoreEmail>
<Address>
<Line1>SOUTHSIDE SHOPPING CTR</Line1>
<Line2>2000 WHARTON ST STE A</Line2>
<City>PITTSBURGH</City>
<MainDivisionCode>PA</MainDivisionCode>
<CountryCode>US</CountryCode>
<PostalCode>15203</PostalCode>
</Address>
</StoreLocation>
<Email>
<EmailAddress>priomidtown@gmail.com</EmailAddress>
</Email>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="billing_1"/>
<Payments>
<CreditCard>
<PaymentContext>
<OrderAppId>TMSUS-eb2c</OrderAppId>
<PaymentSessionId>0002685852538153</PaymentSessionId>
<TenderType>VS</TenderType>
<PaymentAccountUniqueId isToken="true">411111vjOiXS1111</PaymentAccountUniqueId>
</PaymentContext>
<PaymentRequestId>59e970f6-b35f-4be3-ac90-72774be38bf7</PaymentRequestId>
<CreateTimeStamp>2018-02-27T03:44:18</CreateTimeStamp>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>000032</BankAuthorizationCode>
<CVV2ResponseCode>M</CVV2ResponseCode>
<AVSResponseCode>Y</AVSResponseCode>
<AmountAuthorized>248.24</AmountAuthorized>
</Authorization>
<ExpirationDate>2020-09</ExpirationDate>
</CreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<PrintedCatalogCode>40179</PrintedCatalogCode>
<Locale>en_US</Locale>
<DashboardRepId/>
<Source>EB2C</Source>
<OrderHistoryUrl>http://orderlookup.com</OrderHistoryUrl>
</Order>
<Context>
<Locale>en_US</Locale>
<BrowserData>
<HostName>sectst02-live.us.gspt.net</HostName>
<IPAddress>208.247.73.130</IPAddress>
<SessionId>vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG</SessionId>
<UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11</UserAgent>
<Connection>keep-alive</Connection>
<Cookies>s_nr=1328113718440; certona_tracking_parameter=l0.sFfEdofcAAAE1W1R.LV4r; BrowserID_TMSEU-TMSDE-Site=J0.sFfEd6_gAAAE1Zf0HiWj7; BrowserIDCreationTime=1328906239333; cc-cFmsFfEdGpMAAAE1iBNzYkwY=zYWsFfEdtgEAAAE14RAHiWj8; s_rdcvpc=%5B%5B'www.sandbox.paypal.com'%2C'1329321571382'%5D%5D; sid=vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG; pgid-TMSEU-TMSDE-Site=CQVYEt.CH5dSRpcGb9CmasMe0000zLzZeRBA; cc-fYqsFfEd2t8AAAE1oShFf42l=z6esFfEd2pEAAAE10k00oaVb; WA_ReferrerSource=-; s_cc=true; __utma=172174241.570529138.1328906240.1328906240.1329919076.2; __utmb=172174241.7.10.1329919076; __utmc=172174241; __utmz=172174241.1328906240.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none); s_previousPageName=Checkout%3A%20Review%20and%20Submit%20Order; s_sq=gsictmsdedev%3D%2526pid%253DCheckout%25253A%252520Review%252520and%252520Submit%252520Order%2526pidt%253D1%2526oid%253DSubmit%252520Order%2526oidt%253D3%2526ot%253DSUBMIT</Cookies>
<JavascriptData>TF1;015;;;;;;;;;;;;;;;;;;;;;;Mozilla;Netscape;5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;20030107;undefined;true;;true;Win32;undefined;Mozilla/5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;en-US;ISO-8859-1;sectst02-live.us.gspt.net;undefined;undefined;undefined;undefined;true;false;1329919276230;-5;Tue%20Jun%2007%202005%2021%3A33%3A44%20GMT-0400%20%28Eastern%20Daylight%20Time%29;1440;900;;10.3;;;;;3;300;240;Wed%20Feb%2022%202012%2009%3A01%3A16%20GMT-0500%20%28Eastern%20Standard%20Time%29;32;1378;900;0;0;;;;;;Shockwave%20Flash%7CShockwave%20Flash%2011.1%20r102;;;;;;;;;Silverlight%20Plug-In%7C4.0.60531.0;;;;15;</JavascriptData>
<Referrer>https://sectst02-live.us.gspt.net/gsi/webstore/WFS/TMSEU-TMSDE-Site/de_DE/-/EUR/ViewData-Start/1749939151?JumpTarget=ViewCheckoutReview-Start</Referrer>
<HTTPAcceptData>
<ContentTypes>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</ContentTypes>
<Encoding>gzip,deflate,sdch</Encoding>
<Language>en-US,en;q=0.8</Language>
<CharSet>ISO-8859-1,utf-8;q=0.7,*;q=0.3</CharSet>
</HTTPAcceptData>
</BrowserData>
<TdlOrderTimestamp>2014-11-19T17:36:27</TdlOrderTimestamp>
<SessionInfo>
<RTCTransactionResponseCode>RTCTransactionResponseCode</RTCTransactionResponseCode>
<RTCReasonCodes>RTCReasonCodes</RTCReasonCodes>
</SessionInfo>
<CustomAttributes>
<Attribute>
<Key>CARTID</Key>
<Value>00025676291476350</Value>
</Attribute>
<Attribute>
<Key>AmexNameResp</Key>
<Value>Sir Digsby Chicken Caesar</Value>
</Attribute>
<Attribute>
<Key>AmexPhoneResp</Key>
<Value>Hello, how are you</Value>
</Attribute>
</CustomAttributes>
</Context>
</OrderCreateRequest>New subscription order
A subscription item's OrderItem element includes an subscriptionRef attribute. The subscriptionRef value ties the item to a subscription element (in this example fixedSubscription1) that defines the details of the subscription.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" requestId="554432">
<Order customerOrderId="00040string" levelOfService="REGULAR">
<Customer customerId="00001string">
<Name>
<LastName>Minimum</LastName>
<MiddleName>Mo</MiddleName>
<FirstName>Joe</FirstName>
</Name>
<EmailAddress>customer@shopping.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
<TaxExemptFlag>true</TaxExemptFlag>
</Customer>
<CreateTime>2010-02-25T14:04:33</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="201" isHiddenGift="false"
taxAndDutyDisplay="string" isSubscribable="true"
subscriptionRef="fixedSubscription1">
<ItemId>Item0002</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Essentials Short Sleeve Tee</Description>
<Color id="red">Red</Color>
<Size id="10">10</Size>
</Description>
. . .
<Shipping>
<ShipGroups>
<ShipGroup id="shipgroup_1" chargeType="FLAT">
<DestinationTarget ref="dest_1"/>
<OrderItems>
<Item ref="item_1"/>
</OrderItems>
<Gifting>
<Gift>
<ItemId>7175304</ItemId>
<Pricing>
<Amount>3.12</Amount>
<UnitPrice>1.98</UnitPrice>
</Pricing>
<Message>
<To>Gifttag To</To>
<From>Gifttag From</From>
<Message>Gifttag Message</Message>
</Message>
</Gift>
<Packslip>
<Message>
<To>Packslip To</To>
<From>Packslip From</From>
<Message>Packslip Message</Message>
</Message>
</Packslip>
</Gifting>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="dest_1">
<PersonName>
<Honorific>Mr.</Honorific>
<LastName>Receiver</LastName>
<MiddleName>MidTest</MiddleName>
<FirstName>Mary</FirstName>
</PersonName>
<Address>
<Line1>333 Maple Drive</Line1>
<Line2>New No. 4</Line2>
<Line3>Old No. 33</Line3>
<Line4>Park Apartments</Line4>
<City>Elkins Park</City>
<CountryCode>US</CountryCode>
<PostalCode>19027</PostalCode>
</Address>
<Phone>215-555-1212</Phone>
</MailingAddress>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="dest_1"/>
<Payments>
<CreditCard>
<PaymentContext>
<PaymentSessionId>19283746509</PaymentSessionId>
<TenderType>VC</TenderType>
<PaymentAccountUniqueId isToken="true">4111094781641111</PaymentAccountUniqueId>
</PaymentContext>
<PaymentRequestId>12345678909</PaymentRequestId>
<CreateTimeStamp>2010-02-25T14:02:11</CreateTimeStamp>
<Authorization>
<ResponseCode>OK</ResponseCode>
<BankAuthorizationCode>102834756</BankAuthorizationCode>
<CVV2ResponseCode>M</CVV2ResponseCode>
<AVSResponseCode>Y</AVSResponseCode>
<ExtendedAuthorizationResponseCodes>
<ResponseCodeDescription>Lorem Ipsum Dolor Sit</ResponseCodeDescription>
<ReasonCode>0</ReasonCode>
</ExtendedAuthorizationResponseCodes>
<AmountAuthorized>99.99</AmountAuthorized>
</Authorization>
<ExpirationDate>2001-10Z</ExpirationDate>
</CreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<Associate>
<Name>Suresh</Name>
<Number>1</Number>
<Store>TRU</Store>
</Associate>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<PrintedCatalogCode>Jan2010</PrintedCatalogCode>
<Locale>en_US</Locale>
<DashboardRepId>3434</DashboardRepId>
<CustomAttributes>
<Attribute>
<Key>CustomOrderAttrib1</Key>
<Value>yyy</Value>
</Attribute>
<Attribute>
<Key>CustomOrderAttrib2</Key>
<Value>xxx</Value>
</Attribute>
</CustomAttributes>
<OrderHistoryUrl>http://www.fogdog.com/myaccount/orderTracking</OrderHistoryUrl>
<Subscriptions>
<!--Zero or more repetitions:-->
<FixedSubscription id="fixedSubscription1">
<!--Optional:-->
<SubscriptionId>string</SubscriptionId>
<!--Optional:-->
<ParentOrderId>string</ParentOrderId>
<!--Optional:-->
<Label>string</Label>
<Interval type="WEEKLY">3</Interval>
<CurrentInterval>3</CurrentInterval>
<MaxIntervals>3</MaxIntervals>
<!--Optional:-->
<StartDate>2019-06-11</StartDate>
<ChargeAmount>1000.00</ChargeAmount>
</FixedSubscription>
</Subscriptions>
</Order>
<Context>
<BrowserData>
<HostName>tbleu-sectst02-edit.us.gspt.net</HostName>
<IPAddress>172.21.241.28</IPAddress>
<SessionId>n4oQcTuXv9EQcXVOvMqGgC47HFH0oLhMe1uTqt9G</SessionId>
<UserAgent>Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET
CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E)
</UserAgent>
<Connection>Keep-Alive</Connection>
<Cookies>AuthenticationStateToken-B52sFfGWGBQAAAE0Zt0l9wAJ=3a3bfd6794ad08afd9f363ff6c1d4298</Cookies>
<JavascriptData>
TF1;015;5;8;17562;6%2C1%2C7601%2C17514;6%2C1%2C7601%2C17514;;;;8%2C0%2C7601%2C17514;;;
8%2C0%2C7100%2C0;;8%2C0%2C7601%2C17514;6%2C1%2C7601%2C17514;12%2C0%2C7601%2C17514;;8%2C0%2C7601%2C17514;
6%2C1%2C7601%2C17514;;5%2C0%2C5000%2C0;Mozilla;Microsoft%20Internet%20Explorer;4.0%20%28compatible%3B
%20MSIE%207.0%3B%20Windows%20NT%206.1%3B%20Trident/4.0%3B%20SLCC2%3B%20.NET%20CLR%202.0.50727%3B%20.NET
%20CLR%203.5.30729%3B%20.NET%20CLR%203.0.30729%3B%20Media%20Center%20PC%206.0%3B%20.NET4.0C%3B%20.NET4.0E
%29;0;en-us;true;x86;true;Win32;en-us;Mozilla/4.0%20%28compatible%3B%20MSIE%207.0%3B%20Windows%20NT%206.1
%3B%20Trident/4.0%3B%20SLCC2%3B%20.NET%20CLR%202.0.50727%3B%20.NET%20CLR%203.5.30729%3B%20.NET%20CLR
%203.0.30729%3B%20Media%20Center%20PC%206.0%3B%20.NET4.0C%3B%20.NET4.0E%29;en-us;windows-1252;
tbleu-sectst02-edit.us.gspt.net;96;96;true;0;true;false;1322858324273;-5;Tuesday%2C%20June%2007%2C%202005
%209%3A33%3A44%20PM;1366;768;;WIN%2011%2C1%2C102%2C55;;;;;31;300;240;Friday%2C%20December%2002%2C%202011
%203%3A38%3A44%20PM;32;1366;728;undefined;undefined;;;;;;;;;;;;;;;;;;;18;
</JavascriptData>
<Referrer>
https://tbleu-sectst02-edit.us.gspt.net/is-bin/INTERSHOP.enfinity/WFS/TBLEU-TBLUK-Site/
en_GB/-/GBP/ViewData-Start/266624249?JumpTarget=ViewCheckoutReview-Start
</Referrer>
<HTTPAcceptData>
<ContentTypes>image/jpeg, application/x-ms-application, image/gif, application/xaml+xml, image/pjpeg,
application/x-ms-xbap, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword,
*/*
</ContentTypes>
<Encoding>gzip, deflate</Encoding>
<Language>en-US</Language>
<CharSet></CharSet>
</HTTPAcceptData>
</BrowserData>
<TdlOrderTimestamp>2011-12-02T15:38:44.990-05:00</TdlOrderTimestamp>
<SessionInfo>
<TimeSpentOnSite>00:02:47</TimeSpentOnSite>
<LastLogin>2011-12-02T15:37:35.349-05:00</LastLogin>
<UserPassword>2692b41315fe65c0feead745e775d84f</UserPassword>
<AuthorizationAttempts>1</AuthorizationAttempts>
</SessionInfo>
</Context>
</OrderCreateRequest>
New order using Apple Pay
In this example, the tender type is credit card; a custom attribute specifies Apple Pay as the wallet type.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" orderType="SALES" requestId="00474143956042">
<Order customerOrderId="005130802628055 ">
<Customer customerId="0052346789">
<Name>
<LastName>March</LastName>
<MiddleName />
<FirstName>Jo</FirstName>
</Name>
<EmailAddress>jmarch@gmail.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account>11223344556</Account>
<Program>CCCPLUS</Program>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<CreateTime>2022-04-27T10:31:01-04:00</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="1">
<ItemId>100-012345678</ItemId>
<Quantity>3</Quantity>
<Description>
<Description>Shea Butter</Description>
<Color id="9999">Hand Cream</Color>
<Size id="9999">8 oz / 226 g</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>43.50</Amount>
<PromotionalDiscounts>
<Discount>
<Id>FBC_b3g1</Id>
<Code>FBC_b3g1</Code>
<Amount>10.88</Amount>
<Description>Mix & Match: Buy 3, Get 1 Free</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>76800</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28101" jurisdictionLevel="STATE">OHIO</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0575</EffectiveRate>
<TaxableAmount>32.62</TaxableAmount>
<CalculatedTax>1.88</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28565" jurisdictionLevel="COUNTY">FRANKLIN</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.0125</EffectiveRate>
<TaxableAmount>32.62</TaxableAmount>
<CalculatedTax>0.41</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="78115" jurisdictionLevel="DISTRICT">CENTRAL OHIO TRANSIT AUTHORITY</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.005</EffectiveRate>
<TaxableAmount>32.62</TaxableAmount>
<CalculatedTax>0.16</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>14.50</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.22</Amount>
<TaxData>
<TaxClass>91000</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28101" jurisdictionLevel="STATE">OHIO</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0575</EffectiveRate>
<TaxableAmount>5.22</TaxableAmount>
<CalculatedTax>0.20</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28565" jurisdictionLevel="COUNTY">FRANKLIN</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.0125</EffectiveRate>
<TaxableAmount>5.22</TaxableAmount>
<CalculatedTax>0.04</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="78115" jurisdictionLevel="DISTRICT">CENTRAL OHIO TRANSIT AUTHORITY</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.005</EffectiveRate>
<TaxableAmount>5.22</TaxableAmount>
<CalculatedTax>0.02</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod displayText="Standard">ANY_STD</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<CustomAttributes>
<Attribute>
<Key>IMAGEURL</Key>
<Value>https://www.candlesandmore.com/dw/image/v2/CAMUS_PRD/on/demandware.static/-/Sites-master-catalog/default/dw9cd3c3a9/hires/026204882.jpg?sh=471</Value>
</Attribute>
<Attribute>
<Key>PRODUCTURL</Key>
<Value>https://www.candlesandmore.com/p/shea-butter-hand-cream-026204882.html</Value>
</Attribute>
<Attribute>
<Key>EstimatedDeliveryDateFROM</Key>
<Value>2022-05-02T00:00:00-00:00</Value>
</Attribute>
<Attribute>
<Key>EstimatedDeliveryDateTO</Key>
<Value>2022-05-06T00:00:00-00:00</Value>
</Attribute>
</CustomAttributes>
<ReservationId>1651069861331</ReservationId>
</OrderItem>
<OrderItem id="item_2" webLineId="2">
<ItemId>230-026212910</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Hand Savior</Description>
<Color id="9999">Hand Cream</Color>
<Size id="9999">8 oz / 226 g</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>14.50</Amount>
<PromotionalDiscounts>
<Discount>
<Id>FBC_b3g1</Id>
<Code>FBC_b3g1</Code>
<Amount>3.62</Amount>
<Description>Mix & Match: Buy 3, Get 1 Free</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>76800</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28101" jurisdictionLevel="STATE">OHIO</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0575</EffectiveRate>
<TaxableAmount>10.88</TaxableAmount>
<CalculatedTax>0.63</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28565" jurisdictionLevel="COUNTY">FRANKLIN</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.0125</EffectiveRate>
<TaxableAmount>10.88</TaxableAmount>
<CalculatedTax>0.14</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="78115" jurisdictionLevel="DISTRICT">CENTRAL OHIO TRANSIT AUTHORITY</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.005</EffectiveRate>
<TaxableAmount>10.88</TaxableAmount>
<CalculatedTax>0.05</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>14.50</UnitPrice>
</Merchandise>
<Shipping>
<Amount>1.77</Amount>
<TaxData>
<TaxClass>91000</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28101" jurisdictionLevel="STATE">OHIO</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0575</EffectiveRate>
<TaxableAmount>1.77</TaxableAmount>
<CalculatedTax>0.20</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="28565" jurisdictionLevel="COUNTY">FRANKLIN</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.0125</EffectiveRate>
<TaxableAmount>1.77</TaxableAmount>
<CalculatedTax>0.04</CalculatedTax>
</Tax>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>ADMINISTRATIVE_ORIGIN</Situs>
<Jurisdiction jurisdictionId="78115" jurisdictionLevel="DISTRICT">CENTRAL OHIO TRANSIT AUTHORITY</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Local Sales and Use Tax</Imposition>
<EffectiveRate>0.005</EffectiveRate>
<TaxableAmount>1.77</TaxableAmount>
<CalculatedTax>0.02</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod displayText="Standard">ANY_STD</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<CustomAttributes>
<Attribute>
<Key>IMAGEURL</Key>
<Value>https://www.candlesandmore.com/dw/image/v2/CAMUS_PRD/on/demandware.static/-/Sites-master-catalog/default/dwc37af1ae/hires/026212910.jpg?sh=471</Value>
</Attribute>
<Attribute>
<Key>PRODUCTURL</Key>
<Value>https://www.candlesandmore.com/p/hand-savior-hand-cream-026212910.html</Value>
</Attribute>
<Attribute>
<Key>EstimatedDeliveryDateFROM</Key>
<Value>2022-05-02T00:00:00-00:00</Value>
</Attribute>
<Attribute>
<Key>EstimatedDeliveryDateTO</Key>
<Value>2022-05-06T00:00:00-00:00</Value>
</Attribute>
</CustomAttributes>
<ReservationId>1651069861331</ReservationId>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup chargeType="FLAT" id="shipgroup_1">
<DestinationTarget ref="ship_address_home_1" />
<OrderItems>
<Item ref="item_1" />
<Item ref="item_2" />
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="ship_address_home_1">
<PersonName>
<LastName>March</LastName>
<FirstName>Jo</FirstName>
</PersonName>
<Address>
<Line1>935 First Avenue</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>610-555-1212</Phone>
</MailingAddress>
<MailingAddress id="billing_address_1">
<PersonName>
<LastName>March</LastName>
<FirstName>Jo</FirstName>
</PersonName>
<Address>
<Line1>935 First Avenue</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>610-555-1212</Phone>
</MailingAddress>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="billing_address_1" />
<Payments>
<CreditCard>
<PaymentContext>
<PaymentSessionId>00474143956042</PaymentSessionId>
<TenderType>VC</TenderType>
<PaymentAccountUniqueId isToken="true">4444444RGKv44444</PaymentAccountUniqueId>
</PaymentContext>
<PaymentRequestId>1651659863478</PaymentRequestId>
<CreateTimeStamp>2022-04-27T10:31:01-04:00</CreateTimeStamp>
<Amount>54.28</Amount>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>023110</BankAuthorizationCode>
<CVV2ResponseCode>0</CVV2ResponseCode>
<AVSResponseCode>T</AVSResponseCode>
<ExtendedAuthorizationResponseCodes>
<ResponseCodeDescription>APPROVED</ResponseCodeDescription>
<ReasonCode>APPROVED</ReasonCode>
</ExtendedAuthorizationResponseCodes>
<AmountAuthorized>54.28</AmountAuthorized>
</Authorization>
<CustomAttributes>
<Attribute>
<Key>WALLETTYPE</Key>
<Value>APPLEPAY</Value>
</Attribute>
</CustomAttributes>
</CreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<Locale>en_US</Locale>
<CustomAttributes>
<Attribute>
<Key>ORDTAXERR</Key>
<Value>N</Value>
</Attribute>
<Attribute>
<Key>RDFUID</Key>
<Value>0d571652-86c2-4fd9-8042-f0c148dac38a_1651047867524</Value>
</Attribute>
<Attribute>
<Key>ORDERCHANNEL</Key>
<Value>WEB</Value>
</Attribute>
</CustomAttributes>
<OrderHistoryUrl>https://www.candlesandmore.com/on/demandware.store/Sites-CandlesAndMore-Site/en_US/Order-Track?orderID=143956042</OrderHistoryUrl>
</Order>
<Context>
<BrowserData>
<HostName>107.10.226.128</HostName>
<IPAddress>107.10.226.128</IPAddress>
<SessionId>RTglwTab5sUxCJ8TlgeAVPhxOikgT9H-tyk=</SessionId>
<UserAgent>Mozilla/5.0 (iPhone; CPU iPhone OS 15_4_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) (BathAndBodyWorks; iOS; 4.6.0)</UserAgent>
<JavascriptData>null</JavascriptData>
<Referrer>https://www.bathandbodyworks.com/cart</Referrer>
<HTTPAcceptData>
<ContentTypes>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</ContentTypes>
<Encoding>gzip</Encoding>
<Language>en-US,en;q=0.9</Language>
<CharSet>UTF-8</CharSet>
</HTTPAcceptData>
</BrowserData>
<SessionInfo>
<TimeSpentOnSite>00:04:28</TimeSpentOnSite>
<AuthorizationAttempts>0</AuthorizationAttempts>
</SessionInfo>
</Context>
</OrderCreateRequest>
Response XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<ResponseStatus>Success</ResponseStatus>
<ResponseDescription>CustomerOrderId = 005130802628055 , OrderUUID = d948ccec-31a1-4182-85d4-8da844487068</ResponseDescription>
</OrderCreateResponse>New order with items to be shipped together
If there are items in an order that must be shipped together, you can define a relationship in the OrderCreate request. If there is an issue with any item in the relationship during allocation, the other items are canceled or backordered.
Request XML
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<OrderCreateRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" orderType="SALES" requestId="e01374dd-d213-4176-ab07-a480ddbe8973" sessionId="e01374dd-d213-4176-ab07-a480ddbe8973" testType="">
<Order customerOrderId="0002687846074888" levelOfService="REGULAR">
<Customer customerId="null7792082245">
<Name>
<LastName>Jones</LastName>
<FirstName>Indiana</FirstName>
</Name>
<EmailAddress>testapprove@radial.com</EmailAddress>
</Customer>
<CreateTime>2022-04-26T20:23:41</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="1">
<ItemId>21-RITOCS001a</ItemId>
<Quantity>2</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>228.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
<OrderItem id="item_2" webLineId="2">
<ItemId>21-RITOCS002a</ItemId>
<Quantity>2</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>228.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
<OrderItem id="item_3" webLineId="3">
<ItemId>21-RITOCS002b</ItemId>
<Quantity>2</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>228.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
<OrderItem id="item_4" webLineId="4">
<ItemId>21-BO_MAX_ShipTogether3</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31154" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>448.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31154" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
<OrderItem id="item_5" webLineId="5">
<ItemId>21-NonBO_MAX_ShipTogether3</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>228.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
<OrderItem id="item_6" webLineId="6">
<ItemId>21-NonBO_MAX_ShipTogether4</ItemId>
<Quantity>2</Quantity>
<Description>
<Description>Black Tennis Shoes</Description>
<Color id="700">Brown</Color>
<Size id="6-M">6-M</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>114.00</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>228.0</TaxableAmount>
<CalculatedTax>13.68</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>114.00</UnitPrice>
</Merchandise>
<Shipping>
<Amount>5.00</Amount>
<TaxData>
<TaxClass>93000</TaxClass>
<Taxes>
<Tax taxType="SELLER_USE" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="31152" jurisdictionLevel="STATE">PENNSYLVANIA</Jurisdiction>
<Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition>
<EffectiveRate>0.0</EffectiveRate>
<TaxableAmount>0.3</TaxableAmount>
<CalculatedTax>0.0</CalculatedTax>
</Tax>
</Taxes>
</TaxData>
</Shipping>
</Pricing>
<ShippingMethod>ANY_2DAY</ShippingMethod>
<FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</DeliveryWindow>
<ShippingWindow>
<From>2022-04-28T21:23:46.000Z</From>
<To>2022-04-28T21:23:46.000Z</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>custom template</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>PVAR_CODE_COLOR</Key>
<Value>700</Value>
</Attribute>
</CustomAttributes>
<ReservationId>0002687846074253</ReservationId>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup chargeType="FLATRATE" id="shipgroup_1">
<DestinationTarget ref="address_1" />
<OrderItems>
<Item ref="item_1" />
<Item ref="item_2" />
<Item ref="item_3" />
<Item ref="item_4" />
<Item ref="item_5" />
<Item ref="item_6" />
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="address_1">
<PersonName>
<LastName>Jones</LastName>
<FirstName>Indiana</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Road</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>610-222-3333</Phone>
</MailingAddress>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="address_1" />
<Payments>
<PrepaidCreditCard type="PR">
<Amount>2000.00</Amount>
<Brand>VisaCard</Brand>
<TenderType>PR</TenderType>
</PrepaidCreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<Locale>en_US</Locale>
<Relationships>
<Relationship parent="item_1">
<Members>
<Item ref="item_2" />
</Members>
<Type>SHIPTOGETHER</Type>
<Name>Makeup Kit1</Name>
</Relationship>
<Relationship parent="item_3">
<Members>
<Item ref="item_4" />
<Item ref="item_5" />
</Members>
<Type>SHIPTOGETHER</Type>
<Name>Makeup Kit2</Name>
</Relationship>
</Relationships>
<Source>WEB</Source>
</Order>
<Context>
<BrowserData>
<HostName>sectst02-live.us.gspt.net</HostName>
<IPAddress>208.247.73.130</IPAddress>
<SessionId>vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG</SessionId>
<UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11</UserAgent>
<Connection>keep-alive</Connection>
<Cookies>s_nr=1328113718440; certona_tracking_parameter=l0.sFfEdofcAAAE1W1R.LV4r; BrowserID_TMSEU-TMSDE-Site=J0.sFfEd6_gAAAE1Zf0HiWj7; BrowserIDCreationTime=1328906239333; cc-cFmsFfEdGpMAAAE1iBNzYkwY=zYWsFfEdtgEAAAE14RAHiWj8; s_rdcvpc=%5B%5B'www.sandbox.paypal.com'%2C'1329321571382'%5D%5D; sid=vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG; pgid-TMSEU-TMSDE-Site=CQVYEt.CH5dSRpcGb9CmasMe0000zLzZeRBA; cc-fYqsFfEd2t8AAAE1oShFf42l=z6esFfEd2pEAAAE10k00oaVb; WA_ReferrerSource=-; s_cc=true; __utma=172174241.570529138.1328906240.1328906240.1329919076.2; __utmb=172174241.7.10.1329919076; __utmc=172174241; __utmz=172174241.1328906240.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none); s_previousPageName=Checkout%3A%20Review%20and%20Submit%20Order; s_sq=gsictmsdedev%3D%2526pid%253DCheckout%25253A%252520Review%252520and%252520Submit%252520Order%2526pidt%253D1%2526oid%253DSubmit%252520Order%2526oidt%253D3%2526ot%253DSUBMIT</Cookies>
<JavascriptData>TF1;015;;;;;;;;;;;;;;;;;;;;;;Mozilla;Netscape;5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;20030107;undefined;true;;true;Win32;undefined;Mozilla/5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;en-US;ISO-8859-1;sectst02-live.us.gspt.net;undefined;undefined;undefined;undefined;true;false;1329919276230;-5;Tue%20Jun%2007%202005%2021%3A33%3A44%20GMT-0400%20%28Eastern%20Daylight%20Time%29;1440;900;;10.3;;;;;3;300;240;Wed%20Feb%2022%202012%2009%3A01%3A16%20GMT-0500%20%28Eastern%20Standard%20Time%29;32;1378;900;0;0;;;;;;Shockwave%20Flash%7CShockwave%20Flash%2011.1%20r102;;;;;;;;;Silverlight%20Plug-In%7C4.0.60531.0;;;;15;</JavascriptData>
<Referrer>https://sectst02-live.us.gspt.net/gsi/webstore/WFS/TMSEU-TMSDE-Site/de_DE/-/EUR/ViewData-Start/1749939151?JumpTarget=ViewCheckoutReview-Start</Referrer>
<HTTPAcceptData>
<ContentTypes>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</ContentTypes>
<Encoding>gzip,deflate,sdch</Encoding>
<Language>en-US,en;q=0.8</Language>
<CharSet>ISO-8859-1,utf-8;q=0.7,*;q=0.3</CharSet>
</HTTPAcceptData>
</BrowserData>
<TdlOrderTimestamp>2014-11-19T17:36:27</TdlOrderTimestamp>
<SessionInfo>
<RTCTransactionResponseCode>RTCTransactionResponseCode</RTCTransactionResponseCode>
<RTCReasonCodes>RTCReasonCodes</RTCReasonCodes>
</SessionInfo>
<CustomAttributes>
<Attribute>
<Key>CARTID</Key>
<Value>00025676291476350</Value>
</Attribute>
</CustomAttributes>
</Context>
</OrderCreateRequest>Response
The ROM UI displays the results. In this example, the following screens in the ROM user interface show the order and the canceled items.
Client Validation Errors
Client validation errors occur when the Order Create request contains bad data. These errors are http 400 Bad Request errors. The following tables describes the possible errors.
| Error | Description | XML Sample |
|---|---|---|
| XML Schema Validation |
ROM validates all requests against the XML schema. If any XSD validation fails, a validation error occurs. |
|
| Missing First and Last Name |
If both a first and last name are empty or missing on the mailing adddress in the destination section of the request, a validation error occurs. Either a first name or last name must be present. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>both firstName and lastName are empty for the address with id=dest_1</Description>
</Fault>
|
| Discount Amount Greater than Charged Amount |
For any given charge on a request, if the total discount amount of that charge is greater than the actual charge amount, a validation error occurs. This validation is applied to all the charges at both the header level and line level. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>discount amount is more than charge amount || webLineId=1 ,
chargeName=Shipping chargeAmount=2.97 TotalDiscountAmount=3.96</Description>
</Fault>
|
| Duplicate Payment Tender |
Unique payments are expected in the payments section of the request. If the incoming request has duplicate payment entries in payments sections, a validation error occurs. This validation is applied to all tenders, including credit card, stored value card, prepaid card, prepaid COD, and PayPal. |
Credit Card <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>duplicate payments=[123456|CC|CREDIT_CARD] present in the request</Description>
</Fault>
Stored Value Card <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>duplicate payments=[810002R7rSS5105|GS|STORED_VALUE_CARD] present in the request</Description>
</Fault>
Prepaid <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>duplicate payments=[PR|PREPAID_CARD] present in the request</Description>
</Fault>
Prepaid COD <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>duplicate payments=[COD|PREPAID_COD] present in the request</Description>
</Fault>
PayPal <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>duplicate payments=[****-****-****-YPAL|PY|PAYPAL] present in the request</Description>
</Fault>
|
| Duplicate WebLineId |
A unique WebLineId is expected for each line item in the request. If the incoming request has multiple lines with the same WebLineIds, a validation error occurs. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>There are lines with duplicate webline number in order</Description>
</Fault>
|
| Order Prefix Validation | If a seller has a prefix value configured for the customerOrderId and CustomerId, then the incoming request's customerOrderId and CustomerId values must contain that configured prefix value. If a prefix is configured and the request customerOrderId or CustomerId values do not contain that prefix, a validation error occurs. |
Order Rejected Validations
The following table describes the errors that occur when ROM rejects an order because it has insufficient data to process the order. All the errors, along with input requests, are sent to the error-reprocessor and are stored in its database.
| Error | Description | XML Sample |
|---|---|---|
| Customer OrderId Validation |
If an order already exists in ROM, the incoming order is not saved. |
"errorPayload": "Duplicate customerOrderId [00026458871422235Test2]", "code" : "ValidationException", "description" : "Duplicate customerOrderId [00026458871422235Test2]", "type" : "VALIDATION" |
| Item Validation |
If any of the line items in the order request is not present or not active in ROM, the order is rejected. |
"errorPayload" : "Missing item 21-ritOCS001all for seller [TMSUS]", "Code" : "ValidationException", "desription" : "Missing item 21-ritOCS001all for seller [TMSUS]", "type" : VALIDATION" |
| Ship Method Validation |
If any of the line items ship method in the order request is not present in ROM, the order is rejected. |
"errorPayload" : "Invalid shipping method [ANY_STD1] for lineNo [1]", "Code" : "ValidationException", "desription" : "Invalid shipping method [ANY_STD1] for lineNo [1]", "type" : VALIDATION" |
| SellerId Validation |
If a given seller ID is not active in ROM, the order is rejected. |
|
| Payment Validation |
If TenderType or PaymentType are not configured for a given seller, the order is rejected. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<CreateTimeStamp>2021-09-01T13:12:45.583Z</CreateTimeStamp>
<Code>ValidationException</Code>
<Description>Invalid payment type or tender type</Description>
</Fault>
|