Price Adjustment
When a shopper buys or returns an item, you must sometimes adjust the original price. This type of adjustment can occur when:
You need to send a refund to the shopper for an item that has already been invoiced; for example, when a shopper returns an item and does not want to exchange it.
You need to modify charges of items that have not yet been invoiced.
What Is the Price Adjustment Process?
The Price Adjustment process uses the Radial priceadjustment API to identify orders and line items, determine the reason for the price adjustment, and validate the adjustment.
The following diagram illustrates the price adjustment process.
How It Works
Typically, a customer care agent creates the adjustment request, then specifies whether the adjustment is at the order level or line level.
Next, the agent selects the type adjustment; for example, price, shipping, or tax credit, and the reason for the adjustment. Finally, the agent saves the request and forwards it for review and approval.
Price Adjustment JSON API
Action | URI Template | Transaction Type |
---|---|---|
POST | /sellers/{sellerId}/orders/{orderId}/priceadjust | Return information for a price adjustment. |
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.
Example Request
This example shows line item adjustments.
https://uat01-epapi-na.gsipartners.com/v1.0/stores/<storeid>/order-manage/customerorder/<order number>/priceadjust.json
{
"validationRequest": false,
"orderDocumentType": "SALES",
"modificationInfo": {
"requestSource": "CustomerCare",
"userInfo": {
"id": "0058b001234Fxg7dAAB",
"name": "Amanda ABC"
}
},
"transaction": {
"id": "012041239/3/2024 12:37 PM",
"interactionId": "01204123"
},
"lineAdjustments": [
{
"category": "PriceAdjustment",
"amount": 28,
"reasonCode": "MIS",
"reasonDescription": "Wrong Item Received DC",
"lineIds": [
"2"
]
},
{
"category": "PriceAdjustment",
"amount": 32,
"reasonCode": "MIS",
"reasonDescription": "Wrong Item Received DC",
"lineIds": [
"3"
]
}
]
}
Example Response
{
"sellerId": "TMSUS",
"orderId": "30006600180",
"orderDocumentType": "SALES",
"modificationInfo": {
"reasonCode": "GSE",
"reasonDescription": "Site Price Error",
"requestSource": "CustomerCare",
"userInfo": {
"id": "00559000001e1ghAAA",
"name": "Test Radial ALL"
}
},
"transaction": {
"id": "000150579/17/2024 3:43 PM",
"interactionId": "00015057"
},
"validationRequest": false,
"lineAdjustments": [
{
"category": "PriceAdjustment",
"amount": 2,
"reasonCode": "GSE",
"reasonDescription": "Site Price Error",
"responseInfo": {
"code": "GSIPAB000"
},
"lineIds": [
"1"
]
}
],
"responseCode": "GSIPAB000"
}
Response Codes
Code | Description |
---|---|
GSIPAB000 | Price Adjustment can be applied. / Price Adjustment is applied. |
GSIPAB001 | Requested amount exceeds net adjustable amount. |
GSIPAB002 | TDF Offline / TDF Time out |
GSIPAB004 | Adjustments cannot be done on an order line where prices are for information only. |
GSIPAB005 | Adjustments cannot be done on an order line containing quantity pending shipments. |