docs: update generated docs (#981)
diff --git a/docs/dyn/content_v2_1.orders.html b/docs/dyn/content_v2_1.orders.html
index a99ed2c..9fa445f 100644
--- a/docs/dyn/content_v2_1.orders.html
+++ b/docs/dyn/content_v2_1.orders.html
@@ -114,11 +114,17 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
+ <code><a href="#refunditem">refunditem(merchantId, orderId, body=None)</a></code></p>
+<p class="firstline">Issues a partial or total refund for items and shipment.</p>
+<p class="toc_element">
+ <code><a href="#refundorder">refundorder(merchantId, orderId, body=None)</a></code></p>
+<p class="firstline">Issues a partial or total refund for an order.</p>
+<p class="toc_element">
<code><a href="#rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</a></code></p>
<p class="firstline">Rejects return on an line item.</p>
<p class="toc_element">
<code><a href="#returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</a></code></p>
-<p class="firstline">Returns and refunds a line item. Note that this method can only be called on fully shipped orders.</p>
+<p class="firstline">Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.</p>
<p class="toc_element">
<code><a href="#setlineitemmetadata">setlineitemmetadata(merchantId, orderId, body=None)</a></code></p>
<p class="firstline">Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.</p>
@@ -318,6 +324,27 @@
# - "`template2`"
# - "`template3`"
"testOrder": { # The test order to create.
+ "deliveryDetails": { # Overrides the predefined delivery details if provided.
+ "address": { # The delivery address
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ },
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ },
"enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
"kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
"lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
@@ -374,6 +401,7 @@
"methodName": "A String", # Required. The name of the shipping method.
"minDaysInTransit": 42, # Required. Minimum transit time.
},
+ "pickupPromiseInMinutes": 42, # The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
"shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
"type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
#
@@ -384,6 +412,39 @@
},
],
"notificationMode": "A String", # Restricted. Do not use.
+ "pickupDetails": { # Overrides the predefined pickup details if provided.
+ "locationCode": "A String", # Required. Code of the location defined by provider or merchant.
+ "pickupLocationAddress": { # Required. Pickup location address.
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ },
+ "pickupLocationType": "A String", # Pickup location type.
+ #
+ # Acceptable values are:
+ # - "`locker`"
+ # - "`store`"
+ # - "`curbside`"
+ "pickupPersons": [ # Required. all pickup persons set by users.
+ {
+ "name": "A String", # Required. Full name of the pickup person.
+ "phoneNumber": "A String", # Required. The phone number of the person picking up the items.
+ },
+ ],
+ },
"predefinedBillingAddress": "A String", # Required. The billing address.
#
# Acceptable values are:
@@ -410,7 +471,7 @@
# - "`pam`"
"promotions": [ # Promotions associated with the order.
{
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "applicableItems": [ # Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -418,7 +479,7 @@
"quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "appliedItems": [ # Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -536,6 +597,12 @@
{ # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
"acknowledged": True or False, # Whether the order was acknowledged.
+ "annotations": [ # List of key-value pairs that are attached to a given order.
+ {
+ "key": "A String", # Key for additional google provided (as key-value pairs) annotation.
+ "value": "A String", # Value for additional google provided (as key-value pairs) annotation.
+ },
+ ],
"billingAddress": { # The billing address.
"country": "A String", # CLDR country code (e.g. "US").
"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
@@ -761,6 +828,7 @@
"methodName": "A String", # Required. The name of the shipping method.
"minDaysInTransit": 42, # Required. Minimum transit time.
},
+ "pickupPromiseInMinutes": 42, # The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
"shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
"type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
#
@@ -817,6 +885,14 @@
},
],
"locationId": "A String", # ID of the pickup location.
+ "pickupType": "A String", # The pickup type of this order.
+ #
+ # Acceptable values are:
+ # - "`merchantStore`"
+ # - "`merchantStoreCurbside`"
+ # - "`merchantStoreLocker`"
+ # - "`thirdPartyPickupPoint`"
+ # - "`thirdPartyLocker`"
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
"promotions": [ # Promotions associated with the order.
@@ -831,7 +907,7 @@
#
# More details about the program are here.
{
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "applicableItems": [ # Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -839,7 +915,7 @@
"quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "appliedItems": [ # Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -1007,6 +1083,10 @@
"quantity": 42, # The quantity that is shipped.
},
],
+ "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed.
+ "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery.
+ "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format.
+ },
"shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
"status": "A String", # The status of the shipment.
#
@@ -1061,6 +1141,12 @@
"kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
"order": { # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==) # The requested order.
"acknowledged": True or False, # Whether the order was acknowledged.
+ "annotations": [ # List of key-value pairs that are attached to a given order.
+ {
+ "key": "A String", # Key for additional google provided (as key-value pairs) annotation.
+ "value": "A String", # Value for additional google provided (as key-value pairs) annotation.
+ },
+ ],
"billingAddress": { # The billing address.
"country": "A String", # CLDR country code (e.g. "US").
"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
@@ -1286,6 +1372,7 @@
"methodName": "A String", # Required. The name of the shipping method.
"minDaysInTransit": 42, # Required. Minimum transit time.
},
+ "pickupPromiseInMinutes": 42, # The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
"shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
"type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
#
@@ -1342,6 +1429,14 @@
},
],
"locationId": "A String", # ID of the pickup location.
+ "pickupType": "A String", # The pickup type of this order.
+ #
+ # Acceptable values are:
+ # - "`merchantStore`"
+ # - "`merchantStoreCurbside`"
+ # - "`merchantStoreLocker`"
+ # - "`thirdPartyPickupPoint`"
+ # - "`thirdPartyLocker`"
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
"promotions": [ # Promotions associated with the order.
@@ -1356,7 +1451,7 @@
#
# More details about the program are here.
{
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "applicableItems": [ # Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -1364,7 +1459,7 @@
"quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "appliedItems": [ # Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -1532,6 +1627,10 @@
"quantity": 42, # The quantity that is shipped.
},
],
+ "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed.
+ "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery.
+ "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format.
+ },
"shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
"status": "A String", # The status of the shipment.
#
@@ -1585,6 +1684,7 @@
template1b -
template2 -
template3 -
+ template4 -
country: string, The country of the template to retrieve. Defaults to `US`.
Returns:
@@ -1593,6 +1693,27 @@
{
"kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
"template": { # The requested test order template.
+ "deliveryDetails": { # Overrides the predefined delivery details if provided.
+ "address": { # The delivery address
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ },
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ },
"enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
"kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
"lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
@@ -1649,6 +1770,7 @@
"methodName": "A String", # Required. The name of the shipping method.
"minDaysInTransit": 42, # Required. Minimum transit time.
},
+ "pickupPromiseInMinutes": 42, # The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
"shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
"type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
#
@@ -1659,6 +1781,39 @@
},
],
"notificationMode": "A String", # Restricted. Do not use.
+ "pickupDetails": { # Overrides the predefined pickup details if provided.
+ "locationCode": "A String", # Required. Code of the location defined by provider or merchant.
+ "pickupLocationAddress": { # Required. Pickup location address.
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ },
+ "pickupLocationType": "A String", # Pickup location type.
+ #
+ # Acceptable values are:
+ # - "`locker`"
+ # - "`store`"
+ # - "`curbside`"
+ "pickupPersons": [ # Required. all pickup persons set by users.
+ {
+ "name": "A String", # Required. Full name of the pickup person.
+ "phoneNumber": "A String", # Required. The phone number of the person picking up the items.
+ },
+ ],
+ },
"predefinedBillingAddress": "A String", # Required. The billing address.
#
# Acceptable values are:
@@ -1685,7 +1840,7 @@
# - "`pam`"
"promotions": [ # Promotions associated with the order.
{
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "applicableItems": [ # Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -1693,7 +1848,7 @@
"quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "appliedItems": [ # Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -1857,6 +2012,12 @@
"resources": [
{ # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
"acknowledged": True or False, # Whether the order was acknowledged.
+ "annotations": [ # List of key-value pairs that are attached to a given order.
+ {
+ "key": "A String", # Key for additional google provided (as key-value pairs) annotation.
+ "value": "A String", # Value for additional google provided (as key-value pairs) annotation.
+ },
+ ],
"billingAddress": { # The billing address.
"country": "A String", # CLDR country code (e.g. "US").
"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
@@ -2082,6 +2243,7 @@
"methodName": "A String", # Required. The name of the shipping method.
"minDaysInTransit": 42, # Required. Minimum transit time.
},
+ "pickupPromiseInMinutes": 42, # The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
"shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
"type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
#
@@ -2138,6 +2300,14 @@
},
],
"locationId": "A String", # ID of the pickup location.
+ "pickupType": "A String", # The pickup type of this order.
+ #
+ # Acceptable values are:
+ # - "`merchantStore`"
+ # - "`merchantStoreCurbside`"
+ # - "`merchantStoreLocker`"
+ # - "`thirdPartyPickupPoint`"
+ # - "`thirdPartyLocker`"
},
"placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
"promotions": [ # Promotions associated with the order.
@@ -2152,7 +2322,7 @@
#
# More details about the program are here.
{
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "applicableItems": [ # Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -2160,7 +2330,7 @@
"quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "appliedItems": [ # Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item.
{
"lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
"offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
@@ -2328,6 +2498,10 @@
"quantity": 42, # The quantity that is shipped.
},
],
+ "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed.
+ "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery.
+ "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format.
+ },
"shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
"status": "A String", # The status of the shipment.
#
@@ -2384,6 +2558,122 @@
</div>
<div class="method">
+ <code class="details" id="refunditem">refunditem(merchantId, orderId, body=None)</code>
+ <pre>Issues a partial or total refund for items and shipment.
+
+Args:
+ merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
+ orderId: string, The ID of the order to refund. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "items": [ # The items that are refunded. Either Item or Shipping must be provided in the request.
+ {
+ "amount": { # The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer.
+ "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 .
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "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`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ },
+ "fullRefund": True or False, # If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored.
+ "lineItemId": "A String", # The ID of the line item. Either lineItemId or productId is required.
+ "productId": "A String", # The ID of the product. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The number of products that are refunded.
+ },
+ ],
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "reason": "A String", # The reason for the refund.
+ #
+ # Acceptable values are:
+ # - "`shippingCostAdjustment`"
+ # - "`priceAdjustment`"
+ # - "`taxAdjustment`"
+ # - "`feeAdjustment`"
+ # - "`courtesyAdjustment`"
+ # - "`adjustment`"
+ # - "`customerCancelled`"
+ # - "`noInventory`"
+ # - "`productNotAsDescribed`"
+ # - "`undeliverableShippingAddress`"
+ # - "`wrongProductShipped`"
+ # - "`lateShipmentCredit`"
+ # - "`deliveredLateByCarrier`"
+ # - "`productArrivedDamaged`"
+ "reasonText": "A String", # The explanation of the reason.
+ "shipping": { # The refund on shipping. Optional, but either Item or Shipping must be provided in the request.
+ "amount": { # The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "fullRefund": True or False, # If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "executionStatus": "A String", # The status of the execution.
+ #
+ # Acceptable values are:
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersRefundItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundItemResponse".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="refundorder">refundorder(merchantId, orderId, body=None)</code>
+ <pre>Issues a partial or total refund for an order.
+
+Args:
+ merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
+ orderId: string, The ID of the order to refund. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "amount": { # The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount.
+ "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 .
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "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`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ },
+ "fullRefund": True or False, # If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "reason": "A String", # The reason for the refund.
+ #
+ # Acceptable values are:
+ # - "`courtesyAdjustment`"
+ # - "`other`"
+ "reasonText": "A String", # The explanation of the reason.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "executionStatus": "A String", # The status of the execution.
+ #
+ # Acceptable values are:
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersRefundOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundOrderResponse".
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</code>
<pre>Rejects return on an line item.
@@ -2425,7 +2715,7 @@
<div class="method">
<code class="details" id="returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</code>
- <pre>Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
+ <pre>Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
@@ -2636,14 +2926,18 @@
{
"carrier": "A String", # The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.
"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.
+ "lastPickupDate": "A String", # Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and `status` is `ready for pickup`.
"operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "readyPickupDate": "A String", # Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if `status` is `ready for pickup`.
"shipmentId": "A String", # The ID of the shipment.
"status": "A String", # New status for the shipment. Not updated if missing.
#
# Acceptable values are:
# - "`delivered`"
# - "`undeliverable`"
+ # - "`readyForPickup`"
"trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
+ "undeliveredDate": "A String", # Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if `status` is `undeliverable`.
}