Zero Cost Reship API

The Create Reship operation creates a zero cost reship request. This operation allows you to use your own customer service tools to reship an order at no cost to the shopper.

URI Summary

Schemas

Error Codes

Example

Operation	Action	URI Template	URI Example	Transaction Type	Unique RequestID Needed for Duplicate Detection?	Non-URI Request Payload
Create reship	POST	/vM.m/stores/STOREID/orders/reship/create.format	/v1.0/stores/ABCD/orders/reship/create.xml	Create zero cost reship request.	No	Reship-Create-1.0.xsd

Error Code	Error Description	Scenario	Header/ Line
GSIZCR0001	Requested quantity is more than available quantity to reship.	QuantityToReship passed in the input XML is more than the quantity available to reship.	Line
GSIZCR0009	There is a TDF error. Submit the request later.	There is an error reaching out to TDF when creating a reship request.	Header
GSIZCR0003	Original order or line for reship cannot be found with the information in the request.	An order number that does not exist in OMS is received in the request, an invalid Prime/Sub line number is sent in the request, or a wrong EnterpriseCode is present in the incoming request.	Header
GSIZCR0007	Payment type is invalid.	The input request has an invalid PaymentType value.	Header
GSIZCR0006	Ship method is invalid.	A line in the reship submit request has an invalid ship method.	Header
GSIZCR0004	Bill-to address is missing.	The bill-to address is missing.	Header
GSIZCR0008	Line type is invalid.	An invalid LineType value is passed in the request to create a reship.
GSIZCR0005	Error occurs when processing reship request. Contact admin.	None of the specific errors apply.
VALID	No error.	No error.	Header or line

<?xml version="1.0" encoding="UTF-8"?><
ReshipCreateRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" orderType="SALES">
   <SourceSystem>CustomerCare</SourceSystem>
   <Agent id="1234" name="testAgent"/>
   <InteractionId>A5830EB2AC156946003965A537D8C89D</InteractionId>
   <TransactionId>001650</TransactionId>
   <CustomerOrderId>100001521815</CustomerOrderId>
   <SourceId type="STORE">TMSNAe</SourceId>
   <Order>
      <Customer>
         <EmailAddress>RIT_APGTestAuto@dashboard.gsi</EmailAddress>
      </Customer>
      <OrderItems>
         <OrderItem id="item1" lineId="1" returnRequired="true" subLineId="1">
            <Quantity>1</Quantity>
            <ReasonCode>WI</ReasonCode>
            <ShippingMethod>ANY_2DAY</ShippingMethod>
            <EstimatedDeliveryDate>
               <DeliveryWindow>
                  <From>2015-04-06T18:53:21.000Z</From>
                  <To>2015-04-07T18:53:21.000Z</To>
               </DeliveryWindow>
               <ShippingWindow>
                  <From>2015-04-06T18:53:21.000Z</From>
                  <To>2015-04-07T18:53:21.000Z</To>
               </ShippingWindow>
            </EstimatedDeliveryDate>
         </OrderItem>
      </OrderItems>
      <Shipping>
         <ShipGroups>
            <ShipGroup>
               <DestinationTarget ref="dest_1"/>
               <OrderItems>
                  <Item ref="item1"/>
               </OrderItems>
            </ShipGroup>
         </ShipGroups>
         <Destinations>
            <MailingAddress id="dest_1">
               <PersonName>
                  <LastName>Test</LastName>
                  <FirstName>User</FirstName>
               </PersonName>
               <Address>
                  <Line1>630 Allendale Rd</Line1>
                  <City>King Of Prussia</City>
                  <CountryCode>US</CountryCode>
                  <PostalCode>19406</PostalCode>
               </Address>
               <Phone>484-222-2345</Phone>
            </MailingAddress>
         </Destinations>
      </Shipping>
      <Payment>
         <BillingAddress ref="dest_1"/>
         <Payments>
            <CreditCard useAlternateMerchantId="true">
               <ExpirationDate>2018-04</ExpirationDate>
               <PurchasePlanCode/>
               <PurchasePlanDescription/>
               <PaymentContext>
                  <TenderType>VC</TenderType>
                  <PaymentAccountUniqueId isToken="true">4111094781641111</PaymentAccountUniqueId>
               </PaymentContext>
            </CreditCard>
         </Payments>
      </Payment>
   </Order>
</ReshipCreateRequest>

<?xml version="1.0" encoding="UTF-8"?>
<ReshipCreateResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <SourceId type="STORE">TMSNAe</SourceId>
   <CustomerOrderId>100001905185</CustomerOrderId>
   <TransactionId>001650</TransactionId>
   <ResponseCode>SUCCESS</ResponseCode>
   <ReshipInfo>
      <ReshipWithReturn>
         <GeneratedOrder>
            <OrderType>ZCRExchange</OrderType>
            <CustomerOrderId>100001905185</CustomerOrderId>
            <OrderPurpose>EXCHANGE</OrderPurpose>
         </GeneratedOrder>
         <OrderItems>
            <OrderItem lineId="1" subLineId="1" origLineId="1" origSubLineId="1">
               <ResponseCode>VALID</ResponseCode>
               <TotalChargeIfNotReturned>114.00</TotalChargeIfNotReturned>
            </OrderItem>
         </OrderItems>
      </ReshipWithReturn>
   </ReshipInfo>
</ReshipCreateResponse>