- JSON representation
- ReturnShipment
- ShipmentTrackingInfo
- MerchantOrderReturnItem
- CustomerReturnReason
- RefundReason
- MerchantRejectionReason
- ReturnPricingInfo
Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
JSON representation |
---|
{ "orderReturnId": string, "orderId": string, "merchantOrderId": string, "creationDate": string, "returnShipments": [ { object ( |
Fields | |
---|---|
orderReturnId |
Order return ID generated by Google. |
orderId |
Google order ID. |
merchantOrderId |
Merchant defined order ID. |
creationDate |
The date of creation of the return, in ISO 8601 format. |
returnShipments[] |
Shipments of the return. |
returnItems[] |
Items of the return. |
returnPricingInfo |
Information about shipping costs. |
ReturnShipment
JSON representation |
---|
{
"shipmentId": string,
"state": string,
"creationDate": string,
"shippingDate": string,
"deliveryDate": string,
"shipmentTrackingInfos": [
{
object ( |
Fields | |
---|---|
shipmentId |
Shipment ID generated by Google. |
state |
State of the shipment. Acceptable values are:
|
creationDate |
The date of creation of the shipment, in ISO 8601 format. |
shippingDate |
The date of shipping of the shipment, in ISO 8601 format. |
deliveryDate |
The date of delivery of the shipment, in ISO 8601 format. |
shipmentTrackingInfos[] |
Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially. |
returnMethodType |
Type of the return method. Acceptable values are:
|
ShipmentTrackingInfo
JSON representation |
---|
{ "carrier": string, "trackingNumber": string } |
Fields | |
---|---|
carrier |
The shipping carrier that handles the package. Acceptable values are:
|
trackingNumber |
The tracking number for the package. |
MerchantOrderReturnItem
JSON representation |
---|
{ "itemId": string, "returnShipmentIds": [ string ], "product": { object ( |
Fields | |
---|---|
itemId |
Product level item ID. If the returned items are of the same product, they will have the same ID. |
returnShipmentIds[] |
IDs of the return shipments that this return item belongs to. |
product |
Product data from the time of the order placement. |
state |
State of the item. Acceptable values are:
|
customerReturnReason |
The reason that the customer chooses to return an item. |
merchantReturnReason |
The reason that merchant chooses to accept a return item. |
merchantRejectionReason |
The reason that the merchant chose to reject an item return. |
shipmentGroupId |
ID of the original shipment group. Provided for shipments with invoice support. |
shipmentUnitId |
ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support. |
refundableAmount |
Maximum amount that can be refunded for this return item. |
returnItemId |
Unit level ID for the return item. Different units of the same product will have different IDs. |
CustomerReturnReason
JSON representation |
---|
{ "reasonCode": string, "description": string } |
Fields | |
---|---|
reasonCode |
Code of the return reason. Acceptable values are:
|
description |
Description of the reason. |
RefundReason
JSON representation |
---|
{ "reasonCode": string, "description": string } |
Fields | |
---|---|
reasonCode |
Code of the refund reason. Acceptable values are:
|
description |
Description of the reason. |
MerchantRejectionReason
JSON representation |
---|
{ "reasonCode": string, "description": string } |
Fields | |
---|---|
reasonCode |
Code of the rejection reason. |
description |
Description of the reason. |
ReturnPricingInfo
JSON representation |
---|
{ "refundableItemsTotalAmount": { object ( |
Fields | |
---|---|
refundableItemsTotalAmount |
Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons. |
refundableShippingAmount |
Maximum amount that can be refunded for the original shipping fee. |
chargeReturnShippingFee |
Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned. |
maxReturnShippingFee |
Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned. |
totalRefundedAmount |
Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet. |