Radial Integration | 2016
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:
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 |
To ensure successful processing, adhere to the following business rules when preparing Order Create Request messages.
OrderCreateRequest receives OrderCreateResponse.
Request XML
<?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
<?xml version="1.0" encoding="UTF-8"?> <OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0"> <ResponseStatus>Success</ResponseStatus> </OrderCreateResponse>
OrderCreateRequest receives OrderCreateResponse.
Request XML
<?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
<?xml version="1.0" encoding="UTF-8"?> <OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0"> <ResponseStatus>Success</ResponseStatus> </OrderCreateResponse>
OrderCreateRequest receives OrderCreateResponse.
Request XML
<?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
<?xml version="1.0" encoding="UTF-8"?> <OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0"> <ResponseStatus>Success</ResponseStatus> </OrderCreateResponse>
OrderCreateRequest receives an OrderCreateResponse.
Request XML
<?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
<?xml version="1.0" encoding="UTF-8"?> <OrderCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0"> <ResponseStatus>Success</ResponseStatus> </OrderCreateResponse>
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
<?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> <Pricing> <Merchandise> <Amount>99.99</Amount> <PromotionalDiscounts> <Discount> <Id>Promo3</Id> <Code>PromoCode3</Code> <Amount>4.99</Amount> <Description>Item Discount for Loyalty</Description> <EffectType>Value</EffectType> </Discount> <Discount> <Id>Promo4</Id> <Code>PromoCode4</Code> <Amount>3.99</Amount> <Description>Item Discount for Holidays</Description> </Discount> </PromotionalDiscounts> <TaxData> <TaxClass>890000</TaxClass> <Taxes> <Tax taxType="SALES" taxability="TAXABLE"> <Situs>DESTINATION</Situs> <Jurisdiction jurisdictionLevel="STATE" jurisdictionId="PA">Pennsylvania </Jurisdiction> <Imposition impositionType="imp">imposition</Imposition> <EffectiveRate>0.06</EffectiveRate> <TaxableAmount>99.99</TaxableAmount> <CalculatedTax>5.99</CalculatedTax> <SellerRegistrationId>suresh123</SellerRegistrationId> </Tax> <Tax taxType="VAT" taxability="NONTAXABLE"> <Situs>DESTINATION</Situs> <Jurisdiction jurisdictionLevel="STATE" jurisdictionId="PA">Pennsylvania </Jurisdiction> <Imposition impositionType="imp">imposition</Imposition> <EffectiveRate>0.06</EffectiveRate> <TaxableAmount>30.00</TaxableAmount> <CalculatedTax>1.80</CalculatedTax> </Tax> </Taxes> </TaxData> <UnitPrice>99.99</UnitPrice> </Merchandise> <Shipping> <Amount>9.99</Amount> <PromotionalDiscounts> <Discount> <Id>Promo1</Id> <Code>PromoCode1</Code> <Amount>1.99</Amount> <Description>Shipping Discount for Loyalty</Description> </Discount> <Discount> <Id>Promo2</Id> <Code>PromoCode2</Code> <Amount>2.99</Amount> <Description>Shipping Discount for Holidays</Description> </Discount> </PromotionalDiscounts> <TaxData> <TaxClass>890000</TaxClass> <Taxes> <Tax taxType="SALES" taxability="EXEMPT"> <Situs>SHIP_DESTINATION</Situs> <Jurisdiction jurisdictionLevel="STATE" jurisdictionId="PA">Pennsylvania </Jurisdiction> <Imposition impositionType="imp">ship tax imposition</Imposition> <EffectiveRate>0.06</EffectiveRate> <TaxableAmount>99.99</TaxableAmount> <CalculatedTax>5.99</CalculatedTax> </Tax> </Taxes> </TaxData> <UnitPrice>9.99</UnitPrice> </Shipping> <Duty> <Amount>1.99</Amount> <TaxData> <TaxClass>890000</TaxClass> <Taxes> <Tax taxType="SALES" taxability="EXEMPT"> <Situs>Duty_DESTINATION</Situs> <Jurisdiction jurisdictionLevel="STATE" jurisdictionId="PA">Pennsylvania </Jurisdiction> <Imposition impositionType="imp">duty tax imposition</Imposition> <EffectiveRate>0.02</EffectiveRate> <TaxableAmount>9.99</TaxableAmount> <CalculatedTax>2.99</CalculatedTax> </Tax> </Taxes> </TaxData> <UnitPrice>1.98</UnitPrice> </Duty> </Pricing> <ShippingMethod>1DAY</ShippingMethod> <EstimatedDeliveryDate> <DeliveryWindow> <From>2011-04-12T16:45:00-05:00</From> <To>2011-04-13T16:45:00-05:00</To> </DeliveryWindow> <ShippingWindow> <From>2011-04-12T16:45:00-05:00</From> <To>2011-04-13T16:45:00-05:00</To> </ShippingWindow> <Mode>ENABLED</Mode> <MessageType>Expected Delivery</MessageType> </EstimatedDeliveryDate> <VendorId>Vendor1</VendorId> <VendorName>Broad Street's vendor</VendorName> <SerialNumber>123</SerialNumber> <CustomAttributes> <Attribute> <Key>CustomOrderItemAttrib1</Key> <Value>BRMC</Value> </Attribute> <Attribute> <Key>CustomOrderItemAttrib2</Key> <Value>BJM</Value> </Attribute> </CustomAttributes> <GiftRegistryCancelUrl>http://www.fogdog.com/giftregistry/cancel</GiftRegistryCancelUrl> <ReservationId>12345</ReservationId> </OrderItem> </OrderItems> <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>
Copyright © 2017 Radial. All rights reserved.