acknowledge(merchantId, returnId, body=None, x__xgafv=None)
Acks an order return in your Merchant Center account.
Close httplib2 connections.
createorderreturn(merchantId, body=None, x__xgafv=None)
Create return in your Merchant Center account.
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.
process(merchantId, returnId, body=None, x__xgafv=None)
Processes return in your Merchant Center account.
acknowledge(merchantId, returnId, body=None, x__xgafv=None)
Acks an order return 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) returnId: string, The ID of the return. (required) body: object, The request body. The object takes the form of: { "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order return. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`" "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsAcknowledgeResponse". }
close()
Close httplib2 connections.
createorderreturn(merchantId, body=None, x__xgafv=None)
Create return 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) body: object, The request body. The object takes the form of: { "returnMethodType": "A String", # The way of the package being returned. "orderId": "A String", # The ID of the order. "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. "lineItems": [ # The list of line items to return. { "quantity": 42, # The quantity of this line item. "lineItemId": "A String", # The ID of the line item. This value is assigned by Google when an order is created. }, ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { "orderReturn": { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not. # Created order return. "merchantOrderId": "A String", # Merchant defined order ID. "returnShipments": [ # Shipments of the return. { "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. }, ], "creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format. "deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format. "returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" "shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format. "state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`" "shipmentId": "A String", # Shipment ID generated by Google. }, ], "creationDate": "A String", # The date of creation of the return, in ISO 8601 format. "orderReturnId": "A String", # Order return ID generated by Google. "returnItems": [ # Items of the return. { "shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support. "returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs. "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. "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`" "description": "A String", # Description of the reason. }, "state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`" "returnShipmentIds": [ # IDs of the return shipments that this return item belongs to. "A String", ], "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. "id": "A String", # The REST ID of the product. "targetCountry": "A String", # The CLDR territory // code of the target country of the product. "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. }, ], "fees": [ # Associated fees at order creation time. { "amount": { # Amount of the fee. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "name": "A String", # Name of the fee. }, ], "imageLink": "A String", # URL of an image 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. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`" "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "itemGroupId": "A String", # Shared identifier for all variants of the same product. "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item. "offerId": "A String", # An identifier of the item. "brand": "A String", # Brand of the item. "mpn": "A String", # Manufacturer Part Number (MPN) of the item. }, "refundableAmount": { # Maximum amount that can be refunded for this return item. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support. "merchantRejectionReason": { # The reason that the merchant chose to reject an item return. "description": "A String", # Description of the reason. "reasonCode": "A String", # Code of the rejection reason. }, }, ], "returnPricingInfo": { # Information about shipping costs. "chargeReturnShippingFee": True or False, # 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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, }, "orderId": "A String", # Google order ID. }, "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`" "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsCreateOrderReturnResponse". }
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. "merchantOrderId": "A String", # Merchant defined order ID. "returnShipments": [ # Shipments of the return. { "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. }, ], "creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format. "deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format. "returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" "shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format. "state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`" "shipmentId": "A String", # Shipment ID generated by Google. }, ], "creationDate": "A String", # The date of creation of the return, in ISO 8601 format. "orderReturnId": "A String", # Order return ID generated by Google. "returnItems": [ # Items of the return. { "shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support. "returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs. "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. "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`" "description": "A String", # Description of the reason. }, "state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`" "returnShipmentIds": [ # IDs of the return shipments that this return item belongs to. "A String", ], "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. "id": "A String", # The REST ID of the product. "targetCountry": "A String", # The CLDR territory // code of the target country of the product. "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. }, ], "fees": [ # Associated fees at order creation time. { "amount": { # Amount of the fee. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "name": "A String", # Name of the fee. }, ], "imageLink": "A String", # URL of an image 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. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`" "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "itemGroupId": "A String", # Shared identifier for all variants of the same product. "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item. "offerId": "A String", # An identifier of the item. "brand": "A String", # Brand of the item. "mpn": "A String", # Manufacturer Part Number (MPN) of the item. }, "refundableAmount": { # Maximum amount that can be refunded for this return item. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support. "merchantRejectionReason": { # The reason that the merchant chose to reject an item return. "description": "A String", # Description of the reason. "reasonCode": "A String", # Code of the rejection reason. }, }, ], "returnPricingInfo": { # Information about shipping costs. "chargeReturnShippingFee": True or False, # 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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, }, "orderId": "A String", # Google order ID. }
list(merchantId, shipmentTypes=None, shipmentStatus=None, pageToken=None, orderBy=None, maxResults=None, shipmentStates=None, createdStartDate=None, shipmentTrackingNumbers=None, createdEndDate=None, googleOrderIds=None, acknowledged=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) shipmentTypes: string, Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types. (repeated) Allowed values BY_MAIL - RETURNLESS - CONTACT_CUSTOMER_SUPPORT - shipmentStatus: string, Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses. (repeated) Allowed values NEW - IN_PROGRESS - PROCESSED - 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 - 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. shipmentStates: string, Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states. (repeated) Allowed values NEW - SHIPPED - COMPLETED - UNDELIVERABLE - PENDING - createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format. shipmentTrackingNumbers: string, Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. (repeated) createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format. googleOrderIds: string, Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. (repeated) acknowledged: boolean, Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned. 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. "merchantOrderId": "A String", # Merchant defined order ID. "returnShipments": [ # Shipments of the return. { "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. }, ], "creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format. "deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format. "returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" "shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format. "state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`" "shipmentId": "A String", # Shipment ID generated by Google. }, ], "creationDate": "A String", # The date of creation of the return, in ISO 8601 format. "orderReturnId": "A String", # Order return ID generated by Google. "returnItems": [ # Items of the return. { "shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support. "returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs. "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. "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`" "description": "A String", # Description of the reason. }, "state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`" "returnShipmentIds": [ # IDs of the return shipments that this return item belongs to. "A String", ], "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. "id": "A String", # The REST ID of the product. "targetCountry": "A String", # The CLDR territory // code of the target country of the product. "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. }, ], "fees": [ # Associated fees at order creation time. { "amount": { # Amount of the fee. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "name": "A String", # Name of the fee. }, ], "imageLink": "A String", # URL of an image 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. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`" "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "itemGroupId": "A String", # Shared identifier for all variants of the same product. "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item. "offerId": "A String", # An identifier of the item. "brand": "A String", # Brand of the item. "mpn": "A String", # Manufacturer Part Number (MPN) of the item. }, "refundableAmount": { # Maximum amount that can be refunded for this return item. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support. "merchantRejectionReason": { # The reason that the merchant chose to reject an item return. "description": "A String", # Description of the reason. "reasonCode": "A String", # Code of the rejection reason. }, }, ], "returnPricingInfo": { # Information about shipping costs. "chargeReturnShippingFee": True or False, # 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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "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. "priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value . "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, }, "orderId": "A String", # Google order ID. }, ], "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.
process(merchantId, returnId, body=None, x__xgafv=None)
Processes return 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) returnId: string, The ID of the return. (required) body: object, The request body. The object takes the form of: { "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order return. "fullChargeReturnShippingCost": True or False, # Option to charge the customer return shipping cost. "refundShippingFee": { # Refunds for original shipping fee. "returnRefundReason": "A String", # Code of the refund reason. "reasonText": "A String", # The explanation of the reason. "partialRefund": { # If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer. "priceAmount": { # The pre-tax or post-tax amount to be refunded, depending on the location of the order. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "paymentType": "A String", # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set. "fullRefund": True or False, # If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP. }, "returnItems": [ # The list of items to return. { "reject": { # Rejects the item. "reasonText": "A String", # The explanation of the reason. "reason": "A String", # The reason for the return. }, "refund": { # Refunds the item. "returnRefundReason": "A String", # Code of the refund reason. "reasonText": "A String", # The explanation of the reason. "partialRefund": { # If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer. "priceAmount": { # The pre-tax or post-tax amount to be refunded, depending on the location of the order. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, "taxAmount": { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order. "value": "A String", # The price represented as a number. "currency": "A String", # The currency of the price. }, }, "paymentType": "A String", # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set. "fullRefund": True or False, # If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP. }, "returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs. }, ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`" "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsProcessResponse". }