Create Reship
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
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
---|---|---|---|---|---|---|
Create reship |
POST |
/vM.m/sellers/{sellerId}/orders/{orderId}/reship |
/v1.0/stores/TMSUS/order-manage/orders/1234/reship.json |
Create zero cost reship request. |
No |
Reship-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
Error Codes
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 |
Example
Request JSON
{
"ReshipCreateRequest": {
"SourceSystem": "CustomerCare",
"Agent": "",
"InteractionId": "A5830EB2AC156946003965A537D8C89D",
"TransactionId": 1650,
"CustomerOrderId": 100001521815,
"SourceId": "TMSNAe",
"Order": {
"Customer": {
"EmailAddress": "RIT_APGTestAuto@dashboard.gsi"
},
"OrderItems": {
"OrderItem": {
"Quantity": 1,
"ReasonCode": "WI",
"ShippingMethod": "ANY_2DAY",
"EstimatedDeliveryDate": {
"DeliveryWindow": {
"From": "2015-04-06T18:53:21.000Z",
"To": "2015-04-07T18:53:21.000Z"
},
"ShippingWindow": {
"From": "2015-04-06T18:53:21.000Z",
"To": "2015-04-07T18:53:21.000Z"
}
}
}
},
"Shipping": {
"ShipGroups": {
"ShipGroup": {
"DestinationTarget": "",
"OrderItems": {
"Item": ""
}
}
},
"Destinations": {
"MailingAddress": {
"PersonName": {
"LastName": "Test",
"FirstName": "User"
},
"Address": {
"Line1": "630 Allendale Rd",
"City": "King Of Prussia",
"CountryCode": "US",
"PostalCode": 19406
},
"Phone": "484-222-2345"
}
}
},
"Payment": {
"BillingAddress": "",
"Payments": {
"CreditCard": {
"ExpirationDate": "2018-04",
"PurchasePlanCode": "",
"PurchasePlanDescription": "",
"PaymentContext": {
"TenderType": "VC",
"PaymentAccountUniqueId": 4111094781641111
}
}
}
}
}
}
}
Response JSON
{
{
"ReshipCreateResponse": {
"SourceId": "TMSNAe",
"CustomerOrderId": 100001905185,
"TransactionId": 1650,
"ResponseCode": "SUCCESS",
"ReshipInfo": {
"ReshipWithReturn": {
"GeneratedOrder": {
"OrderType": "ZCRExchange",
"CustomerOrderId": 100001905185,
"OrderPurpose": "EXCHANGE"
},
"OrderItems": {
"OrderItem": {
"ResponseCode": "VALID",
"TotalChargeIfNotReturned": 114
}
}
}
}
}
}