Close httplib2 connections.
get(merchantId, returnId, x__xgafv=None)
Retrieves an order return from your Merchant Center account.
Lists order returns in your Merchant Center account.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
get(merchantId, returnId, x__xgafv=None)
Retrieves an order return from your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
returnId: string, Merchant order return ID generated by Google. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
"returnItems": [ # Items of the return.
{
"returnShipmentIds": [ # IDs of the return shipments that this return item belongs to.
"A String",
],
"itemId": "A String", # Product level item ID. If the returned items are of the same product, they will have the same ID.
"merchantReturnReason": { # The reason that merchant chooses to accept a return item.
"description": "A String", # Description of the reason.
"reasonCode": "A 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`"
},
"state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`"
"customerReturnReason": { # The reason that the customer chooses to return an item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
},
"product": { # Product data from the time of the order placement.
"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
{
"dimension": "A String", # The dimension of the variant.
"value": "A String", # The value for the dimension.
},
],
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"imageLink": "A String", # URL of an image of the item.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"id": "A String", # The REST ID of the product.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"channel": "A String", # The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"offerId": "A String", # An identifier of the item.
"title": "A String", # The title of the product.
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"fees": [ # Associated fees at order creation time.
{
"name": "A String", # Name of the fee.
"amount": { # Amount of the fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
"brand": "A String", # Brand of the item.
"targetCountry": "A String", # The CLDR territory // code of the target country of the product.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`"
},
},
],
"returnShipments": [ # Shipments of the return.
{
"shipmentId": "A String", # Shipment ID generated by Google.
"shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format.
"shipmentTrackingInfos": [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
{
"carrier": "A 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": "A String", # The tracking number for the package.
},
],
"state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`"
"creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format.
"returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`"
"deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format.
},
],
"orderId": "A String", # Google order ID.
"merchantOrderId": "A String", # Merchant defined order ID.
"orderReturnId": "A String", # Order return ID generated by Google.
"creationDate": "A String", # The date of creation of the return, in ISO 8601 format.
}
list(merchantId, pageToken=None, orderBy=None, createdStartDate=None, maxResults=None, createdEndDate=None, x__xgafv=None)
Lists order returns in your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
pageToken: string, The token returned by the previous request.
orderBy: string, Return the results in the specified order.
Allowed values
RETURN_CREATION_TIME_DESC -
RETURN_CREATION_TIME_ASC -
createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format.
maxResults: integer, The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse".
"resources": [
{ # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
"returnItems": [ # Items of the return.
{
"returnShipmentIds": [ # IDs of the return shipments that this return item belongs to.
"A String",
],
"itemId": "A String", # Product level item ID. If the returned items are of the same product, they will have the same ID.
"merchantReturnReason": { # The reason that merchant chooses to accept a return item.
"description": "A String", # Description of the reason.
"reasonCode": "A 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`"
},
"state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`"
"customerReturnReason": { # The reason that the customer chooses to return an item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
},
"product": { # Product data from the time of the order placement.
"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
{
"dimension": "A String", # The dimension of the variant.
"value": "A String", # The value for the dimension.
},
],
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"imageLink": "A String", # URL of an image of the item.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"id": "A String", # The REST ID of the product.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"channel": "A String", # The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"offerId": "A String", # An identifier of the item.
"title": "A String", # The title of the product.
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"fees": [ # Associated fees at order creation time.
{
"name": "A String", # Name of the fee.
"amount": { # Amount of the fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
"brand": "A String", # Brand of the item.
"targetCountry": "A String", # The CLDR territory // code of the target country of the product.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`"
},
},
],
"returnShipments": [ # Shipments of the return.
{
"shipmentId": "A String", # Shipment ID generated by Google.
"shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format.
"shipmentTrackingInfos": [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
{
"carrier": "A 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": "A String", # The tracking number for the package.
},
],
"state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`"
"creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format.
"returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`"
"deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format.
},
],
"orderId": "A String", # Google order ID.
"merchantOrderId": "A String", # Merchant defined order ID.
"orderReturnId": "A String", # Order return ID generated by Google.
"creationDate": "A String", # The date of creation of the return, in ISO 8601 format.
},
],
"nextPageToken": "A String", # The token for the retrieval of the next page of returns.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.