REST Resource: orderreturns

Resource: MerchantOrderReturn

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 (ReturnShipment)
    }
  ],
  "returnItems": [
    {
      object (MerchantOrderReturnItem)
    }
  ]
}
Fields
orderReturnId

string

Order return ID generated by Google.

orderId

string

Google order ID.

merchantOrderId

string

Merchant defined order ID.

creationDate

string

The date of creation of the return, in ISO 8601 format.

returnShipments[]

object (ReturnShipment)

Shipments of the return.

returnItems[]

object (MerchantOrderReturnItem)

Items of the return.

ReturnShipment

JSON representation
{
  "shipmentId": string,
  "state": string,
  "creationDate": string,
  "shippingDate": string,
  "deliveryDate": string,
  "shipmentTrackingInfos": [
    {
      object (ShipmentTrackingInfo)
    }
  ],
  "returnMethodType": string
}
Fields
shipmentId

string

Shipment ID generated by Google.

state

string

State of the shipment.

Acceptable values are:

  • "completed"
  • "new"
  • "shipped"
  • "undeliverable"
  • "pending"

creationDate

string

The date of creation of the shipment, in ISO 8601 format.

shippingDate

string

The date of shipping of the shipment, in ISO 8601 format.

deliveryDate

string

The date of delivery of the shipment, in ISO 8601 format.

shipmentTrackingInfos[]

object (ShipmentTrackingInfo)

Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.

returnMethodType

string

Type of the return method.

Acceptable values are:

  • "byMail"
  • "contactCustomerSupport"
  • "returnless"

ShipmentTrackingInfo

JSON representation
{
  "carrier": string,
  "trackingNumber": string
}
Fields
carrier

string

The shipping carrier that handles the package.

Acceptable values are:

  • "boxtal"
  • "bpost"
  • "chronopost"
  • "colisPrive"
  • "colissimo"
  • "cxt"
  • "deliv"
  • "dhl"
  • "dpd"
  • "dynamex"
  • "eCourier"
  • "easypost"
  • "efw"
  • "fedex"
  • "fedexSmartpost"
  • "geodis"
  • "gls"
  • "googleCourier"
  • "gsx"
  • "jdLogistics"
  • "laPoste"
  • "lasership"
  • "manual"
  • "mpx"
  • "onTrac"
  • "other"
  • "tnt"
  • "uds"
  • "ups"
  • "usps"

trackingNumber

string

The tracking number for the package.

MerchantOrderReturnItem

JSON representation
{
  "itemId": string,
  "returnShipmentIds": [
    string
  ],
  "product": {
    object (OrderLineItemProduct)
  },
  "state": string,
  "customerReturnReason": {
    object (CustomerReturnReason)
  },
  "merchantReturnReason": {
    object (RefundReason)
  }
}
Fields
itemId

string

Product level item ID. If the returned items are of the same product, they will have the same ID.

returnShipmentIds[]

string

IDs of the return shipments that this return item belongs to.

product

object (OrderLineItemProduct)

Product data from the time of the order placement.

state

string

State of the item.

Acceptable values are:

  • "canceled"
  • "new"
  • "received"
  • "refunded"
  • "rejected"

customerReturnReason

object (CustomerReturnReason)

The reason that the customer chooses to return an item.

merchantReturnReason

object (RefundReason)

The reason that merchant chooses to accept a return item.

CustomerReturnReason

JSON representation
{
  "reasonCode": string,
  "description": string
}
Fields
reasonCode

string

Code of the return reason.

Acceptable values are:

  • "betterPriceFound"
  • "changedMind"
  • "damagedOrDefectiveItem"
  • "didNotMatchDescription"
  • "doesNotFit"
  • "expiredItem"
  • "incorrectItemReceived"
  • "noLongerNeeded"
  • "notSpecified"
  • "orderedWrongItem"
  • "other"
  • "qualityNotExpected"
  • "receivedTooLate"
  • "undeliverable"

description

string

Description of the reason.

RefundReason

JSON representation
{
  "reasonCode": string,
  "description": string
}
Fields
reasonCode

string

Code of the refund reason.

Acceptable values are:

  • "adjustment"
  • "autoPostInternal"
  • "autoPostInvalidBillingAddress"
  • "autoPostNoInventory"
  • "autoPostPriceError"
  • "autoPostUndeliverableShippingAddress"
  • "couponAbuse"
  • "courtesyAdjustment"
  • "customerCanceled"
  • "customerDiscretionaryReturn"
  • "customerInitiatedMerchantCancel"
  • "customerSupportRequested"
  • "deliveredLateByCarrier"
  • "deliveredTooLate"
  • "expiredItem"
  • "failToPushOrderGoogleError"
  • "failToPushOrderMerchantError"
  • "failToPushOrderMerchantFulfillmentError"
  • "failToPushOrderToMerchant"
  • "failToPushOrderToMerchantOutOfStock"
  • "feeAdjustment"
  • "invalidCoupon"
  • "lateShipmentCredit"
  • "malformedShippingAddress"
  • "merchantDidNotShipOnTime"
  • "noInventory"
  • "orderTimeout"
  • "other"
  • "paymentAbuse"
  • "paymentDeclined"
  • "priceAdjustment"
  • "priceError"
  • "productArrivedDamaged"
  • "productNotAsDescribed"
  • "promoReallocation"
  • "qualityNotAsExpected"
  • "returnRefundAbuse"
  • "shippingCostAdjustment"
  • "shippingPriceError"
  • "taxAdjustment"
  • "taxError"
  • "undeliverableShippingAddress"
  • "unsupportedPoBoxAddress"
  • "wrongProductShipped"

description

string

Description of the reason.

Methods

get

Retrieves an order return from your Merchant Center account.

list

Lists order returns in your Merchant Center account.