docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/content_v2_1.orders.html b/docs/dyn/content_v2_1.orders.html
index 4ddfc87..a99ed2c 100644
--- a/docs/dyn/content_v2_1.orders.html
+++ b/docs/dyn/content_v2_1.orders.html
@@ -108,7 +108,7 @@
<code><a href="#instorerefundlineitem">instorerefundlineitem(merchantId, orderId, body=None)</a></code></p>
<p class="firstline">Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).</p>
<p class="toc_element">
- <code><a href="#list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</a></code></p>
+ <code><a href="#list">list(merchantId, acknowledged=None, maxResults=None, orderBy=None, pageToken=None, placedDateEnd=None, placedDateStart=None, statuses=None)</a></code></p>
<p class="firstline">Lists the orders in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -146,7 +146,7 @@
The object takes the form of:
{
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
}
@@ -154,18 +154,18 @@
An object of the form:
{
- "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="advancetestorder">advancetestorder(merchantId, orderId)</code>
- <pre>Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".
+ <pre>Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
@@ -175,7 +175,7 @@
An object of the form:
{
- "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
+ "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
}</pre>
</div>
@@ -190,21 +190,21 @@
The object takes the form of:
{
- "reason": "A String", # The reason for the cancellation.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "reason": "A String", # The reason for the cancellation.
#
# Acceptable values are:
- # - "`customerInitiatedCancel`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`noInventory`"
- # - "`other`"
- # - "`priceError`"
- # - "`shippingPriceError`"
- # - "`taxError`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- "reasonText": "A String", # The explanation of the reason.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ # - "`customerInitiatedCancel`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`noInventory`"
+ # - "`other`"
+ # - "`priceError`"
+ # - "`shippingPriceError`"
+ # - "`taxError`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ "reasonText": "A String", # The explanation of the reason.
}
@@ -212,12 +212,12 @@
An object of the form:
{
- "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
}</pre>
</div>
@@ -232,24 +232,24 @@
The object takes the form of:
{
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
- "reason": "A String", # The reason for the cancellation.
+ "lineItemId": "A String", # The ID of the line item to cancel. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "productId": "A String", # The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity to cancel.
+ "reason": "A String", # The reason for the cancellation.
#
# Acceptable values are:
- # - "`customerInitiatedCancel`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`noInventory`"
- # - "`other`"
- # - "`priceError`"
- # - "`shippingPriceError`"
- # - "`taxError`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- "reasonText": "A String", # The explanation of the reason.
- "lineItemId": "A String", # The ID of the line item to cancel. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
- "quantity": 42, # The quantity to cancel.
+ # - "`customerInitiatedCancel`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`noInventory`"
+ # - "`other`"
+ # - "`priceError`"
+ # - "`shippingPriceError`"
+ # - "`taxError`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ "reasonText": "A String", # The explanation of the reason.
}
@@ -257,12 +257,12 @@
An object of the form:
{
- "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
}</pre>
</div>
@@ -277,12 +277,12 @@
The object takes the form of:
{
- "reason": "A String", # The reason for the cancellation.
+ "reason": "A String", # The reason for the cancellation.
#
# Acceptable values are:
- # - "`changedMind`"
- # - "`orderedWrongItem`"
- # - "`other`"
+ # - "`changedMind`"
+ # - "`orderedWrongItem`"
+ # - "`other`"
}
@@ -290,7 +290,7 @@
An object of the form:
{
- "kind": "content#ordersCancelTestOrderByCustomerResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".
+ "kind": "content#ordersCancelTestOrderByCustomerResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".
}</pre>
</div>
@@ -304,184 +304,184 @@
The object takes the form of:
{
- "country": "A String", # The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`.
+ "country": "A String", # The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`.
#
# Acceptable values are:
- # - "`US`"
- # - "`FR`" Defaults to `US`.
- "testOrder": { # The test order to create.
- "promotions": [ # Promotions associated with the order.
+ # - "`US`"
+ # - "`FR`" Defaults to `US`.
+ "templateName": "A String", # The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template.
+ #
+ # Acceptable values are:
+ # - "`template1`"
+ # - "`template1a`"
+ # - "`template1b`"
+ # - "`template2`"
+ # - "`template3`"
+ "testOrder": { # The test order to create.
+ "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.
{
- "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
- "title": "A String", # Required. The title of the promotion.
- "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
- "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`buyMGetMoneyOff`"
- # - "`buyMGetNMoneyOff`"
- # - "`buyMGetNPercentOff`"
- # - "`buyMGetPercentOff`"
- # - "`freeGift`"
- # - "`freeGiftWithItemId`"
- # - "`freeGiftWithValue`"
- # - "`freeShippingOvernight`"
- # - "`freeShippingStandard`"
- # - "`freeShippingTwoDay`"
- # - "`moneyOff`"
- # - "`percentOff`"
- # - "`rewardPoints`"
- # - "`salePrice`"
- "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
- {
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
- },
- ],
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
- {
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
- },
- ],
- "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`product`"
- # - "`shipping`"
- "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`google`"
- # - "`merchant`"
- },
- ],
- "predefinedEmail": "A String", # Required. Email address of the customer.
- #
- # Acceptable values are:
- # - "`pog.dwight.schrute@gmail.com`"
- # - "`pog.jim.halpert@gmail.com`"
- # - "`penpog.pam.beesly@gmail.comding`"
- "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
- "notificationMode": "A String", # Restricted. Do not use.
- "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
- #
- # Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
- "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "shippingOption": "A String", # Required. The requested shipping option.
- #
- # Acceptable values are:
- # - "`economy`"
- # - "`expedited`"
- # - "`oneDay`"
- # - "`sameDay`"
- # - "`standard`"
- # - "`twoDay`"
- "enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
- "lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
- {
- "returnInfo": { # Required. Details of the return policy for the line item.
- "policyUrl": "A String", # Required. URL of the item return policy.
- "isReturnable": True or False, # Required. Whether the item is returnable.
- "daysToReturn": 42, # Required. How many days later the item can be returned.
- },
- "product": { # Required. Product data from the time of the order placement.
- "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "product": { # Required. Product data from the time of the order placement.
+ "brand": "A String", # Required. Brand of the item.
+ "condition": "A String", # Required. Condition or state of the item.
#
# Acceptable values are:
- # - "`en`"
- # - "`fr`"
- "title": "A String", # Required. The title of the product.
- "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
- "variantAttributes": [ # Variant attributes for the item. Optional.
+ # - "`new`"
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ #
+ # Acceptable values are:
+ # - "`en`"
+ # - "`fr`"
+ "fees": [ # Fees for the item. Optional.
{
- "dimension": "A String", # The dimension of the variant.
- "value": "A String", # The value for the dimension.
- },
- ],
- "brand": "A String", # Required. Brand of the item.
- "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
- "offerId": "A String", # Required. An identifier of the item.
- "imageLink": "A String", # Required. URL of an image of the item.
- "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
- "fees": [ # Fees for the item. Optional.
- {
- "amount": { # Amount of the fee.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "amount": { # Amount of the fee.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "name": "A String", # Name of the fee.
+ "name": "A String", # Name of the fee.
},
],
- "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+ "imageLink": "A String", # Required. URL of an image of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+ "offerId": "A String", # Required. An identifier of the item.
+ "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "condition": "A String", # Required. Condition or state of the item.
- #
- # Acceptable values are:
- # - "`new`"
+ "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
+ "title": "A String", # Required. The title of the product.
+ "variantAttributes": [ # Variant attributes for the item. Optional.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
},
- "quantityOrdered": 42, # Required. Number of items ordered.
- "shippingDetails": { # Required. Details of the requested shipping for the line item.
- "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
- "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
+ "quantityOrdered": 42, # Required. Number of items ordered.
+ "returnInfo": { # Required. Details of the return policy for the line item.
+ "daysToReturn": 42, # Required. How many days later the item can be returned.
+ "isReturnable": True or False, # Required. Whether the item is returnable.
+ "policyUrl": "A String", # Required. URL of the item return policy.
+ },
+ "shippingDetails": { # Required. Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
+ "method": { # Required. Details of the shipping method.
+ "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
+ "maxDaysInTransit": 42, # Required. Maximum transit time.
+ "methodName": "A String", # Required. The name of the shipping method.
+ "minDaysInTransit": 42, # Required. Minimum transit time.
+ },
+ "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.
#
# Acceptable values are:
- # - "`delivery`"
- # - "`pickup`"
- "method": { # Required. Details of the shipping method.
- "minDaysInTransit": 42, # Required. Minimum transit time.
- "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
- "methodName": "A String", # Required. The name of the shipping method.
- "maxDaysInTransit": 42, # Required. Maximum transit time.
- },
- "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
+ # - "`delivery`"
+ # - "`pickup`"
},
},
],
- "predefinedBillingAddress": "A String", # Required. The billing address.
+ "notificationMode": "A String", # Restricted. Do not use.
+ "predefinedBillingAddress": "A String", # Required. The billing address.
#
# Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
- "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`pam`"
+ "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
#
# Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`pam`"
+ "predefinedEmail": "A String", # Required. Email address of the customer.
+ #
+ # Acceptable values are:
+ # - "`pog.dwight.schrute@gmail.com`"
+ # - "`pog.jim.halpert@gmail.com`"
+ # - "`penpog.pam.beesly@gmail.comding`"
+ "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
+ #
+ # Acceptable values are:
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`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.
+ {
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ {
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
+ },
+ ],
+ "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`google`"
+ # - "`merchant`"
+ "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
+ "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
+ "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`buyMGetMoneyOff`"
+ # - "`buyMGetNMoneyOff`"
+ # - "`buyMGetNPercentOff`"
+ # - "`buyMGetPercentOff`"
+ # - "`freeGift`"
+ # - "`freeGiftWithItemId`"
+ # - "`freeGiftWithValue`"
+ # - "`freeShippingOvernight`"
+ # - "`freeShippingStandard`"
+ # - "`freeShippingTwoDay`"
+ # - "`moneyOff`"
+ # - "`percentOff`"
+ # - "`rewardPoints`"
+ # - "`salePrice`"
+ "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "title": "A String", # Required. The title of the promotion.
+ "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`product`"
+ # - "`shipping`"
+ },
+ ],
+ "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingOption": "A String", # Required. The requested shipping option.
+ #
+ # Acceptable values are:
+ # - "`economy`"
+ # - "`expedited`"
+ # - "`oneDay`"
+ # - "`sameDay`"
+ # - "`standard`"
+ # - "`twoDay`"
},
- "templateName": "A String", # The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template.
- #
- # Acceptable values are:
- # - "`template1`"
- # - "`template1a`"
- # - "`template1b`"
- # - "`template2`"
- # - "`template3`"
}
@@ -489,8 +489,8 @@
An object of the form:
{
- "orderId": "A String", # The ID of the newly created test order.
- "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
+ "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
+ "orderId": "A String", # The ID of the newly created test order.
}</pre>
</div>
@@ -505,10 +505,10 @@
The object takes the form of:
{
- "items": [ # Returned items.
+ "items": [ # Returned items.
{
- "lineItemId": "A String", # The ID of the line item to return.
- "quantity": 42, # Quantity that is returned.
+ "lineItemId": "A String", # The ID of the line item to return.
+ "quantity": 42, # Quantity that is returned.
},
],
}
@@ -518,8 +518,8 @@
An object of the form:
{
- "returnId": "A String", # The ID of the newly created test order return.
- "kind": "content#ordersCreateTestReturnResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".
+ "kind": "content#ordersCreateTestReturnResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".
+ "returnId": "A String", # The ID of the newly created test order return.
}</pre>
</div>
@@ -535,24 +535,291 @@
An object of the form:
{ # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
- "customer": { # The details of the customer who placed the order.
- "loyaltyInfo": { # Loyalty program information.
- "loyaltyNumber": "A String", # The loyalty card/membership number.
- "name": "A String", # Name of card/membership holder, this field will be populated when
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "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:
+ # 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",
+ ],
+ },
+ "customer": { # The details of the customer who placed the order.
+ "fullName": "A String", # Full name of the customer.
+ "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
+ "loyaltyInfo": { # Loyalty program information.
+ "loyaltyNumber": "A String", # The loyalty card/membership number.
+ "name": "A String", # Name of card/membership holder, this field will be populated when
},
- "fullName": "A String", # Full name of the customer.
- "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
- "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
+ "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
+ "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
#
# Acceptable values are:
- # - "`denied`"
- # - "`granted`"
- "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
- "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
+ # - "`denied`"
+ # - "`granted`"
+ "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
+ "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
},
- "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
},
- "promotions": [ # Promotions associated with the order.
+ "deliveryDetails": { # Delivery details for shipments of type `delivery`.
+ "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.
+ },
+ "id": "A String", # The REST ID of the order. Globally unique.
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
+ "lineItems": [ # Line items that are ordered.
+ {
+ "adjustments": [ # Price and tax adjustments applied on the line item.
+ {
+ "priceAdjustment": { # Adjustment for total price of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "taxAdjustment": { # Adjustment for total tax of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Type of this adjustment.
+ #
+ # Acceptable values are:
+ # - "`promotion`"
+ },
+ ],
+ "annotations": [ # Annotations that are attached to the line item.
+ {
+ "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
+ "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
+ },
+ ],
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "actor": "A String", # The actor that created the cancellation.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "quantity": 42, # The quantity that was canceled.
+ "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
+ #
+ # Acceptable values are:
+ # - "`autoPostInternal`"
+ # - "`autoPostInvalidBillingAddress`"
+ # - "`autoPostNoInventory`"
+ # - "`autoPostPriceError`"
+ # - "`autoPostUndeliverableShippingAddress`"
+ # - "`couponAbuse`"
+ # - "`customerCanceled`"
+ # - "`customerInitiatedCancel`"
+ # - "`customerSupportRequested`"
+ # - "`failToPushOrderGoogleError`"
+ # - "`failToPushOrderMerchantError`"
+ # - "`failToPushOrderMerchantFulfillmentError`"
+ # - "`failToPushOrderToMerchant`"
+ # - "`failToPushOrderToMerchantOutOfStock`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`merchantDidNotShipOnTime`"
+ # - "`noInventory`"
+ # - "`orderTimeout`"
+ # - "`other`"
+ # - "`paymentAbuse`"
+ # - "`paymentDeclined`"
+ # - "`priceError`"
+ # - "`returnRefundAbuse`"
+ # - "`shippingPriceError`"
+ # - "`taxError`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "id": "A String", # The ID of the line item.
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
+ "brand": "A String", # Brand of the item.
+ "condition": "A String", # Condition or state of the item.
+ #
+ # Acceptable values are:
+ # - "`new`"
+ # - "`refurbished`"
+ # - "`used`"
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "fees": [ # Associated fees at order creation time.
+ {
+ "amount": { # Amount of the fee.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "name": "A String", # Name of the fee.
+ },
+ ],
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "id": "A String", # The REST ID of the product.
+ "imageLink": "A String", # URL of an image of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "title": "A String", # The title 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.
+ },
+ ],
+ },
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityDelivered": 42, # Number of items delivered.
+ "quantityOrdered": 42, # Number of items ordered.
+ "quantityPending": 42, # Number of items pending.
+ "quantityReadyForPickup": 42, # Number of items ready for pickup.
+ "quantityReturned": 42, # Number of items returned.
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityUndeliverable": 42, # Number of items undeliverable.
+ "returnInfo": { # Details of the return policy for the line item.
+ "daysToReturn": 42, # Required. How many days later the item can be returned.
+ "isReturnable": True or False, # Required. Whether the item is returnable.
+ "policyUrl": "A String", # Required. URL of the item return policy.
+ },
+ "returns": [ # Returns of the line item.
+ {
+ "actor": "A String", # The actor that created the refund.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "quantity": 42, # Quantity that is returned.
+ "reason": "A String", # The reason for the return.
+ #
+ # Acceptable values are:
+ # - "`customerDiscretionaryReturn`"
+ # - "`customerInitiatedMerchantCancel`"
+ # - "`deliveredTooLate`"
+ # - "`expiredItem`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`other`"
+ # - "`productArrivedDamaged`"
+ # - "`productNotAsDescribed`"
+ # - "`qualityNotAsExpected`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ # - "`wrongProductShipped`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
+ "method": { # Required. Details of the shipping method.
+ "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
+ "maxDaysInTransit": 42, # Required. Maximum transit time.
+ "methodName": "A String", # Required. The name of the shipping method.
+ "minDaysInTransit": 42, # Required. Minimum transit time.
+ },
+ "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.
+ #
+ # Acceptable values are:
+ # - "`delivery`"
+ # - "`pickup`"
+ },
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ },
+ ],
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided ID of the order.
+ "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "paymentStatus": "A String", # The status of the payment.
+ #
+ # Acceptable values are:
+ # - "`paymentCaptured`"
+ # - "`paymentRejected`"
+ # - "`paymentSecured`"
+ # - "`pendingAuthorization`"
+ "pickupDetails": { # Pickup details for shipments of type `pickup`.
+ "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
+ "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",
+ ],
+ },
+ "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
+ {
+ "name": "A String", # Name of the person picking up the shipment.
+ "phoneNumber": "A String", # Phone number of the person picking up the shipment.
+ },
+ ],
+ "locationId": "A String", # ID of the pickup location.
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "promotions": [ # Promotions associated with the order.
#
# To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
#
@@ -564,485 +831,218 @@
#
# More details about the program are here.
{
- "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
- "title": "A String", # Required. The title of the promotion.
- "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
- "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`buyMGetMoneyOff`"
- # - "`buyMGetNMoneyOff`"
- # - "`buyMGetNPercentOff`"
- # - "`buyMGetPercentOff`"
- # - "`freeGift`"
- # - "`freeGiftWithItemId`"
- # - "`freeGiftWithValue`"
- # - "`freeShippingOvernight`"
- # - "`freeShippingStandard`"
- # - "`freeShippingTwoDay`"
- # - "`moneyOff`"
- # - "`percentOff`"
- # - "`rewardPoints`"
- # - "`salePrice`"
- "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`product`"
- # - "`shipping`"
- "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
+ # - "`google`"
+ # - "`merchant`"
+ "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
+ "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
+ "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`google`"
- # - "`merchant`"
+ # - "`buyMGetMoneyOff`"
+ # - "`buyMGetNMoneyOff`"
+ # - "`buyMGetNPercentOff`"
+ # - "`buyMGetPercentOff`"
+ # - "`freeGift`"
+ # - "`freeGiftWithItemId`"
+ # - "`freeGiftWithValue`"
+ # - "`freeShippingOvernight`"
+ # - "`freeShippingStandard`"
+ # - "`freeShippingTwoDay`"
+ # - "`moneyOff`"
+ # - "`percentOff`"
+ # - "`rewardPoints`"
+ # - "`salePrice`"
+ "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "title": "A String", # Required. The title of the promotion.
+ "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`product`"
+ # - "`shipping`"
},
],
- "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
- "shippingCostTax": { # The tax for the total shipping cost.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "shipments": [ # Shipments of the order.
+ "refunds": [ # Refunds for the order.
{
- "status": "A String", # The status of the shipment.
+ "actor": "A String", # The actor that created the refund.
#
# Acceptable values are:
- # - "`delivered`"
- # - "`readyForPickup`"
- # - "`shipped`"
- # - "`undeliverable`"
- "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
- "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
- "carrier": "A String", # The carrier handling the shipment.
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ #
+ # 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`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shipments": [ # Shipments of the order.
+ {
+ "carrier": "A String", # The carrier handling the shipment.
#
# For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
# Supported carriers for US are:
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`usps`" (United States Postal Service) automatic status updates
- # - "`fedex`" (FedEx) automatic status updates
- # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
- # - "`ontrac`" (OnTrac) automatic status updates
- # - "`dhl express`" (DHL Express)
- # - "`deliv`" (Deliv)
- # - "`dynamex`" (TForce)
- # - "`lasership`" (LaserShip)
- # - "`mpx`" (Military Parcel Xpress)
- # - "`uds`" (United Delivery Service)
- # - "`efw`" (Estes Forwarding Worldwide)
- # - "`jd logistics`" (JD Logistics)
- # - "`yunexpress`" (YunExpress)
- # - "`china post`" (China Post)
- # - "`china ems`" (China Post Express Mail Service)
- # - "`singapore post`" (Singapore Post)
- # - "`pos malaysia`" (Pos Malaysia)
- # - "`postnl`" (PostNL)
- # - "`ptt`" (PTT Turkish Post)
- # - "`eub`" (ePacket)
- # - "`chukou1`" (Chukou1 Logistics)
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`usps`" (United States Postal Service) automatic status updates
+ # - "`fedex`" (FedEx) automatic status updates
+ # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
+ # - "`ontrac`" (OnTrac) automatic status updates
+ # - "`dhl express`" (DHL Express)
+ # - "`deliv`" (Deliv)
+ # - "`dynamex`" (TForce)
+ # - "`lasership`" (LaserShip)
+ # - "`mpx`" (Military Parcel Xpress)
+ # - "`uds`" (United Delivery Service)
+ # - "`efw`" (Estes Forwarding Worldwide)
+ # - "`jd logistics`" (JD Logistics)
+ # - "`yunexpress`" (YunExpress)
+ # - "`china post`" (China Post)
+ # - "`china ems`" (China Post Express Mail Service)
+ # - "`singapore post`" (Singapore Post)
+ # - "`pos malaysia`" (Pos Malaysia)
+ # - "`postnl`" (PostNL)
+ # - "`ptt`" (PTT Turkish Post)
+ # - "`eub`" (ePacket)
+ # - "`chukou1`" (Chukou1 Logistics)
# Supported carriers for FR are:
- # - "`la poste`" (La Poste) automatic status updates
- # - "`colissimo`" (Colissimo by La Poste) automatic status updates
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`chronopost`" (Chronopost by La Poste)
- # - "`gls`" (General Logistics Systems France)
- # - "`dpd`" (DPD Group by GeoPost)
- # - "`bpost`" (Belgian Post Group)
- # - "`colis prive`" (Colis Privé)
- # - "`boxtal`" (Boxtal)
- # - "`geodis`" (GEODIS)
- # - "`tnt`" (TNT)
- # - "`db schenker`" (DB Schenker)
- # - "`aramex`" (Aramex)
- "trackingId": "A String", # The tracking ID for the shipment.
- "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
- "lineItems": [ # The line items that are shipped.
+ # - "`la poste`" (La Poste) automatic status updates
+ # - "`colissimo`" (Colissimo by La Poste) automatic status updates
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`chronopost`" (Chronopost by La Poste)
+ # - "`gls`" (General Logistics Systems France)
+ # - "`dpd`" (DPD Group by GeoPost)
+ # - "`bpost`" (Belgian Post Group)
+ # - "`colis prive`" (Colis Privé)
+ # - "`boxtal`" (Boxtal)
+ # - "`geodis`" (GEODIS)
+ # - "`tnt`" (TNT)
+ # - "`db schenker`" (DB Schenker)
+ # - "`aramex`" (Aramex)
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
+ "id": "A String", # The ID of the shipment.
+ "lineItems": [ # The line items that are shipped.
{
- "quantity": 42, # The quantity that is shipped.
- "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
+ "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity that is shipped.
},
],
- "id": "A String", # The ID of the shipment.
- },
- ],
- "refunds": [ # Refunds for the order.
- {
- "amount": { # The amount that is refunded.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reason": "A String", # The reason for the refund.
+ "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
+ "status": "A String", # The status of the shipment.
#
# 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`"
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "reasonText": "A String", # The explanation of the reason.
+ # - "`delivered`"
+ # - "`readyForPickup`"
+ # - "`shipped`"
+ # - "`undeliverable`"
+ "trackingId": "A String", # The tracking ID for the shipment.
},
],
- "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "status": "A String", # The status of the order.
#
# Acceptable values are:
- # - "`marketplaceFacilitator`"
- # - "`merchant`"
- "acknowledged": True or False, # Whether the order was acknowledged.
- "paymentStatus": "A String", # The status of the payment.
+ # - "`canceled`"
+ # - "`delivered`"
+ # - "`inProgress`"
+ # - "`partiallyDelivered`"
+ # - "`partiallyReturned`"
+ # - "`partiallyShipped`"
+ # - "`pendingShipment`"
+ # - "`returned`"
+ # - "`shipped`"
+ "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
#
# Acceptable values are:
- # - "`paymentCaptured`"
- # - "`paymentRejected`"
- # - "`paymentSecured`"
- # - "`pendingAuthorization`"
- "merchantId": "A String",
- "merchantOrderId": "A String", # Merchant-provided ID of the order.
- "status": "A String", # The status of the order.
- #
- # Acceptable values are:
- # - "`canceled`"
- # - "`delivered`"
- # - "`inProgress`"
- # - "`partiallyDelivered`"
- # - "`partiallyReturned`"
- # - "`partiallyShipped`"
- # - "`pendingShipment`"
- # - "`returned`"
- # - "`shipped`"
- "pickupDetails": { # Pickup details for shipments of type `pickup`.
- "locationId": "A String", # ID of the pickup location.
- "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
- {
- "phoneNumber": "A String", # Phone number of the person picking up the shipment.
- "name": "A String", # Name of the person picking up the shipment.
- },
- ],
- "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
- "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "billingAddress": { # The billing address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "lineItems": [ # Line items that are ordered.
- {
- "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
- "targetCountry": "A String", # The CLDR territory code of the target country of the product.
- "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
- "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
- "title": "A String", # The title of the product.
- "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
- "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.
- },
- ],
- "brand": "A String", # Brand of the item.
- "itemGroupId": "A String", # Shared identifier for all variants of the same product.
- "offerId": "A String", # An identifier of the item.
- "price": { # Price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "imageLink": "A String", # URL of an image of the item.
- "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
- "fees": [ # Associated fees at order creation time.
- {
- "amount": { # Amount of the fee.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "name": "A String", # Name of the fee.
- },
- ],
- "id": "A String", # The REST ID of the product.
- "condition": "A String", # Condition or state of the item.
- #
- # Acceptable values are:
- # - "`new`"
- # - "`refurbished`"
- # - "`used`"
- },
- "quantityPending": 42, # Number of items pending.
- "quantityDelivered": 42, # Number of items delivered.
- "returnInfo": { # Details of the return policy for the line item.
- "policyUrl": "A String", # Required. URL of the item return policy.
- "isReturnable": True or False, # Required. Whether the item is returnable.
- "daysToReturn": 42, # Required. How many days later the item can be returned.
- },
- "quantityOrdered": 42, # Number of items ordered.
- "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "adjustments": [ # Price and tax adjustments applied on the line item.
- {
- "type": "A String", # Type of this adjustment.
- #
- # Acceptable values are:
- # - "`promotion`"
- "priceAdjustment": { # Adjustment for total price of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxAdjustment": { # Adjustment for total tax of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- },
- ],
- "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "cancellations": [ # Cancellations of the line item.
- {
- "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
- #
- # Acceptable values are:
- # - "`autoPostInternal`"
- # - "`autoPostInvalidBillingAddress`"
- # - "`autoPostNoInventory`"
- # - "`autoPostPriceError`"
- # - "`autoPostUndeliverableShippingAddress`"
- # - "`couponAbuse`"
- # - "`customerCanceled`"
- # - "`customerInitiatedCancel`"
- # - "`customerSupportRequested`"
- # - "`failToPushOrderGoogleError`"
- # - "`failToPushOrderMerchantError`"
- # - "`failToPushOrderMerchantFulfillmentError`"
- # - "`failToPushOrderToMerchant`"
- # - "`failToPushOrderToMerchantOutOfStock`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`merchantDidNotShipOnTime`"
- # - "`noInventory`"
- # - "`orderTimeout`"
- # - "`other`"
- # - "`paymentAbuse`"
- # - "`paymentDeclined`"
- # - "`priceError`"
- # - "`returnRefundAbuse`"
- # - "`shippingPriceError`"
- # - "`taxError`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the cancellation.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # The quantity that was canceled.
- },
- ],
- "quantityCanceled": 42, # Number of items canceled.
- "annotations": [ # Annotations that are attached to the line item.
- {
- "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
- "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
- },
- ],
- "returns": [ # Returns of the line item.
- {
- "reason": "A String", # The reason for the return.
- #
- # Acceptable values are:
- # - "`customerDiscretionaryReturn`"
- # - "`customerInitiatedMerchantCancel`"
- # - "`deliveredTooLate`"
- # - "`expiredItem`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`other`"
- # - "`productArrivedDamaged`"
- # - "`productNotAsDescribed`"
- # - "`qualityNotAsExpected`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- # - "`wrongProductShipped`"
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # Quantity that is returned.
- },
- ],
- "quantityShipped": 42, # Number of items shipped.
- "quantityReadyForPickup": 42, # Number of items ready for pickup.
- "quantityReturned": 42, # Number of items returned.
- "quantityUndeliverable": 42, # Number of items undeliverable.
- "id": "A String", # The ID of the line item.
- "shippingDetails": { # Details of the requested shipping for the line item.
- "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
- "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
- #
- # Acceptable values are:
- # - "`delivery`"
- # - "`pickup`"
- "method": { # Required. Details of the shipping method.
- "minDaysInTransit": 42, # Required. Minimum transit time.
- "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
- "methodName": "A String", # Required. The name of the shipping method.
- "maxDaysInTransit": 42, # Required. Maximum transit time.
- },
- "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
- },
- },
- ],
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "id": "A String", # The REST ID of the order. Globally unique.
- "deliveryDetails": { # Delivery details for shipments of type `delivery`.
- "phoneNumber": "A String", # The phone number of the person receiving the delivery.
- "address": { # The delivery address
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
+ # - "`marketplaceFacilitator`"
+ # - "`merchant`"
}</pre>
</div>
@@ -1058,26 +1058,293 @@
An object of the form:
{
- "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.
- "customer": { # The details of the customer who placed the order.
- "loyaltyInfo": { # Loyalty program information.
- "loyaltyNumber": "A String", # The loyalty card/membership number.
- "name": "A String", # Name of card/membership holder, this field will be populated when
+ "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.
+ "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:
+ # 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",
+ ],
+ },
+ "customer": { # The details of the customer who placed the order.
+ "fullName": "A String", # Full name of the customer.
+ "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
+ "loyaltyInfo": { # Loyalty program information.
+ "loyaltyNumber": "A String", # The loyalty card/membership number.
+ "name": "A String", # Name of card/membership holder, this field will be populated when
},
- "fullName": "A String", # Full name of the customer.
- "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
- "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
+ "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
+ "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
#
# Acceptable values are:
- # - "`denied`"
- # - "`granted`"
- "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
- "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
+ # - "`denied`"
+ # - "`granted`"
+ "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
+ "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
},
- "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
},
- "promotions": [ # Promotions associated with the order.
+ "deliveryDetails": { # Delivery details for shipments of type `delivery`.
+ "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.
+ },
+ "id": "A String", # The REST ID of the order. Globally unique.
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
+ "lineItems": [ # Line items that are ordered.
+ {
+ "adjustments": [ # Price and tax adjustments applied on the line item.
+ {
+ "priceAdjustment": { # Adjustment for total price of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "taxAdjustment": { # Adjustment for total tax of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Type of this adjustment.
+ #
+ # Acceptable values are:
+ # - "`promotion`"
+ },
+ ],
+ "annotations": [ # Annotations that are attached to the line item.
+ {
+ "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
+ "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
+ },
+ ],
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "actor": "A String", # The actor that created the cancellation.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "quantity": 42, # The quantity that was canceled.
+ "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
+ #
+ # Acceptable values are:
+ # - "`autoPostInternal`"
+ # - "`autoPostInvalidBillingAddress`"
+ # - "`autoPostNoInventory`"
+ # - "`autoPostPriceError`"
+ # - "`autoPostUndeliverableShippingAddress`"
+ # - "`couponAbuse`"
+ # - "`customerCanceled`"
+ # - "`customerInitiatedCancel`"
+ # - "`customerSupportRequested`"
+ # - "`failToPushOrderGoogleError`"
+ # - "`failToPushOrderMerchantError`"
+ # - "`failToPushOrderMerchantFulfillmentError`"
+ # - "`failToPushOrderToMerchant`"
+ # - "`failToPushOrderToMerchantOutOfStock`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`merchantDidNotShipOnTime`"
+ # - "`noInventory`"
+ # - "`orderTimeout`"
+ # - "`other`"
+ # - "`paymentAbuse`"
+ # - "`paymentDeclined`"
+ # - "`priceError`"
+ # - "`returnRefundAbuse`"
+ # - "`shippingPriceError`"
+ # - "`taxError`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "id": "A String", # The ID of the line item.
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
+ "brand": "A String", # Brand of the item.
+ "condition": "A String", # Condition or state of the item.
+ #
+ # Acceptable values are:
+ # - "`new`"
+ # - "`refurbished`"
+ # - "`used`"
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "fees": [ # Associated fees at order creation time.
+ {
+ "amount": { # Amount of the fee.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "name": "A String", # Name of the fee.
+ },
+ ],
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "id": "A String", # The REST ID of the product.
+ "imageLink": "A String", # URL of an image of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "title": "A String", # The title 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.
+ },
+ ],
+ },
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityDelivered": 42, # Number of items delivered.
+ "quantityOrdered": 42, # Number of items ordered.
+ "quantityPending": 42, # Number of items pending.
+ "quantityReadyForPickup": 42, # Number of items ready for pickup.
+ "quantityReturned": 42, # Number of items returned.
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityUndeliverable": 42, # Number of items undeliverable.
+ "returnInfo": { # Details of the return policy for the line item.
+ "daysToReturn": 42, # Required. How many days later the item can be returned.
+ "isReturnable": True or False, # Required. Whether the item is returnable.
+ "policyUrl": "A String", # Required. URL of the item return policy.
+ },
+ "returns": [ # Returns of the line item.
+ {
+ "actor": "A String", # The actor that created the refund.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "quantity": 42, # Quantity that is returned.
+ "reason": "A String", # The reason for the return.
+ #
+ # Acceptable values are:
+ # - "`customerDiscretionaryReturn`"
+ # - "`customerInitiatedMerchantCancel`"
+ # - "`deliveredTooLate`"
+ # - "`expiredItem`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`other`"
+ # - "`productArrivedDamaged`"
+ # - "`productNotAsDescribed`"
+ # - "`qualityNotAsExpected`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ # - "`wrongProductShipped`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
+ "method": { # Required. Details of the shipping method.
+ "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
+ "maxDaysInTransit": 42, # Required. Maximum transit time.
+ "methodName": "A String", # Required. The name of the shipping method.
+ "minDaysInTransit": 42, # Required. Minimum transit time.
+ },
+ "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.
+ #
+ # Acceptable values are:
+ # - "`delivery`"
+ # - "`pickup`"
+ },
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ },
+ ],
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided ID of the order.
+ "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "paymentStatus": "A String", # The status of the payment.
+ #
+ # Acceptable values are:
+ # - "`paymentCaptured`"
+ # - "`paymentRejected`"
+ # - "`paymentSecured`"
+ # - "`pendingAuthorization`"
+ "pickupDetails": { # Pickup details for shipments of type `pickup`.
+ "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
+ "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",
+ ],
+ },
+ "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
+ {
+ "name": "A String", # Name of the person picking up the shipment.
+ "phoneNumber": "A String", # Phone number of the person picking up the shipment.
+ },
+ ],
+ "locationId": "A String", # ID of the pickup location.
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "promotions": [ # Promotions associated with the order.
#
# To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
#
@@ -1089,485 +1356,218 @@
#
# More details about the program are here.
{
- "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
- "title": "A String", # Required. The title of the promotion.
- "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
- "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`buyMGetMoneyOff`"
- # - "`buyMGetNMoneyOff`"
- # - "`buyMGetNPercentOff`"
- # - "`buyMGetPercentOff`"
- # - "`freeGift`"
- # - "`freeGiftWithItemId`"
- # - "`freeGiftWithValue`"
- # - "`freeShippingOvernight`"
- # - "`freeShippingStandard`"
- # - "`freeShippingTwoDay`"
- # - "`moneyOff`"
- # - "`percentOff`"
- # - "`rewardPoints`"
- # - "`salePrice`"
- "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`product`"
- # - "`shipping`"
- "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
+ # - "`google`"
+ # - "`merchant`"
+ "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
+ "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
+ "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`google`"
- # - "`merchant`"
+ # - "`buyMGetMoneyOff`"
+ # - "`buyMGetNMoneyOff`"
+ # - "`buyMGetNPercentOff`"
+ # - "`buyMGetPercentOff`"
+ # - "`freeGift`"
+ # - "`freeGiftWithItemId`"
+ # - "`freeGiftWithValue`"
+ # - "`freeShippingOvernight`"
+ # - "`freeShippingStandard`"
+ # - "`freeShippingTwoDay`"
+ # - "`moneyOff`"
+ # - "`percentOff`"
+ # - "`rewardPoints`"
+ # - "`salePrice`"
+ "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "title": "A String", # Required. The title of the promotion.
+ "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`product`"
+ # - "`shipping`"
},
],
- "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
- "shippingCostTax": { # The tax for the total shipping cost.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "shipments": [ # Shipments of the order.
+ "refunds": [ # Refunds for the order.
{
- "status": "A String", # The status of the shipment.
+ "actor": "A String", # The actor that created the refund.
#
# Acceptable values are:
- # - "`delivered`"
- # - "`readyForPickup`"
- # - "`shipped`"
- # - "`undeliverable`"
- "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
- "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
- "carrier": "A String", # The carrier handling the shipment.
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ #
+ # 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`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shipments": [ # Shipments of the order.
+ {
+ "carrier": "A String", # The carrier handling the shipment.
#
# For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
# Supported carriers for US are:
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`usps`" (United States Postal Service) automatic status updates
- # - "`fedex`" (FedEx) automatic status updates
- # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
- # - "`ontrac`" (OnTrac) automatic status updates
- # - "`dhl express`" (DHL Express)
- # - "`deliv`" (Deliv)
- # - "`dynamex`" (TForce)
- # - "`lasership`" (LaserShip)
- # - "`mpx`" (Military Parcel Xpress)
- # - "`uds`" (United Delivery Service)
- # - "`efw`" (Estes Forwarding Worldwide)
- # - "`jd logistics`" (JD Logistics)
- # - "`yunexpress`" (YunExpress)
- # - "`china post`" (China Post)
- # - "`china ems`" (China Post Express Mail Service)
- # - "`singapore post`" (Singapore Post)
- # - "`pos malaysia`" (Pos Malaysia)
- # - "`postnl`" (PostNL)
- # - "`ptt`" (PTT Turkish Post)
- # - "`eub`" (ePacket)
- # - "`chukou1`" (Chukou1 Logistics)
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`usps`" (United States Postal Service) automatic status updates
+ # - "`fedex`" (FedEx) automatic status updates
+ # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
+ # - "`ontrac`" (OnTrac) automatic status updates
+ # - "`dhl express`" (DHL Express)
+ # - "`deliv`" (Deliv)
+ # - "`dynamex`" (TForce)
+ # - "`lasership`" (LaserShip)
+ # - "`mpx`" (Military Parcel Xpress)
+ # - "`uds`" (United Delivery Service)
+ # - "`efw`" (Estes Forwarding Worldwide)
+ # - "`jd logistics`" (JD Logistics)
+ # - "`yunexpress`" (YunExpress)
+ # - "`china post`" (China Post)
+ # - "`china ems`" (China Post Express Mail Service)
+ # - "`singapore post`" (Singapore Post)
+ # - "`pos malaysia`" (Pos Malaysia)
+ # - "`postnl`" (PostNL)
+ # - "`ptt`" (PTT Turkish Post)
+ # - "`eub`" (ePacket)
+ # - "`chukou1`" (Chukou1 Logistics)
# Supported carriers for FR are:
- # - "`la poste`" (La Poste) automatic status updates
- # - "`colissimo`" (Colissimo by La Poste) automatic status updates
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`chronopost`" (Chronopost by La Poste)
- # - "`gls`" (General Logistics Systems France)
- # - "`dpd`" (DPD Group by GeoPost)
- # - "`bpost`" (Belgian Post Group)
- # - "`colis prive`" (Colis Privé)
- # - "`boxtal`" (Boxtal)
- # - "`geodis`" (GEODIS)
- # - "`tnt`" (TNT)
- # - "`db schenker`" (DB Schenker)
- # - "`aramex`" (Aramex)
- "trackingId": "A String", # The tracking ID for the shipment.
- "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
- "lineItems": [ # The line items that are shipped.
+ # - "`la poste`" (La Poste) automatic status updates
+ # - "`colissimo`" (Colissimo by La Poste) automatic status updates
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`chronopost`" (Chronopost by La Poste)
+ # - "`gls`" (General Logistics Systems France)
+ # - "`dpd`" (DPD Group by GeoPost)
+ # - "`bpost`" (Belgian Post Group)
+ # - "`colis prive`" (Colis Privé)
+ # - "`boxtal`" (Boxtal)
+ # - "`geodis`" (GEODIS)
+ # - "`tnt`" (TNT)
+ # - "`db schenker`" (DB Schenker)
+ # - "`aramex`" (Aramex)
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
+ "id": "A String", # The ID of the shipment.
+ "lineItems": [ # The line items that are shipped.
{
- "quantity": 42, # The quantity that is shipped.
- "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
+ "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity that is shipped.
},
],
- "id": "A String", # The ID of the shipment.
- },
- ],
- "refunds": [ # Refunds for the order.
- {
- "amount": { # The amount that is refunded.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reason": "A String", # The reason for the refund.
+ "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
+ "status": "A String", # The status of the shipment.
#
# 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`"
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "reasonText": "A String", # The explanation of the reason.
+ # - "`delivered`"
+ # - "`readyForPickup`"
+ # - "`shipped`"
+ # - "`undeliverable`"
+ "trackingId": "A String", # The tracking ID for the shipment.
},
],
- "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "status": "A String", # The status of the order.
#
# Acceptable values are:
- # - "`marketplaceFacilitator`"
- # - "`merchant`"
- "acknowledged": True or False, # Whether the order was acknowledged.
- "paymentStatus": "A String", # The status of the payment.
+ # - "`canceled`"
+ # - "`delivered`"
+ # - "`inProgress`"
+ # - "`partiallyDelivered`"
+ # - "`partiallyReturned`"
+ # - "`partiallyShipped`"
+ # - "`pendingShipment`"
+ # - "`returned`"
+ # - "`shipped`"
+ "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
#
# Acceptable values are:
- # - "`paymentCaptured`"
- # - "`paymentRejected`"
- # - "`paymentSecured`"
- # - "`pendingAuthorization`"
- "merchantId": "A String",
- "merchantOrderId": "A String", # Merchant-provided ID of the order.
- "status": "A String", # The status of the order.
- #
- # Acceptable values are:
- # - "`canceled`"
- # - "`delivered`"
- # - "`inProgress`"
- # - "`partiallyDelivered`"
- # - "`partiallyReturned`"
- # - "`partiallyShipped`"
- # - "`pendingShipment`"
- # - "`returned`"
- # - "`shipped`"
- "pickupDetails": { # Pickup details for shipments of type `pickup`.
- "locationId": "A String", # ID of the pickup location.
- "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
- {
- "phoneNumber": "A String", # Phone number of the person picking up the shipment.
- "name": "A String", # Name of the person picking up the shipment.
- },
- ],
- "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
- "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "billingAddress": { # The billing address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "lineItems": [ # Line items that are ordered.
- {
- "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
- "targetCountry": "A String", # The CLDR territory code of the target country of the product.
- "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
- "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
- "title": "A String", # The title of the product.
- "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
- "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.
- },
- ],
- "brand": "A String", # Brand of the item.
- "itemGroupId": "A String", # Shared identifier for all variants of the same product.
- "offerId": "A String", # An identifier of the item.
- "price": { # Price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "imageLink": "A String", # URL of an image of the item.
- "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
- "fees": [ # Associated fees at order creation time.
- {
- "amount": { # Amount of the fee.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "name": "A String", # Name of the fee.
- },
- ],
- "id": "A String", # The REST ID of the product.
- "condition": "A String", # Condition or state of the item.
- #
- # Acceptable values are:
- # - "`new`"
- # - "`refurbished`"
- # - "`used`"
- },
- "quantityPending": 42, # Number of items pending.
- "quantityDelivered": 42, # Number of items delivered.
- "returnInfo": { # Details of the return policy for the line item.
- "policyUrl": "A String", # Required. URL of the item return policy.
- "isReturnable": True or False, # Required. Whether the item is returnable.
- "daysToReturn": 42, # Required. How many days later the item can be returned.
- },
- "quantityOrdered": 42, # Number of items ordered.
- "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "adjustments": [ # Price and tax adjustments applied on the line item.
- {
- "type": "A String", # Type of this adjustment.
- #
- # Acceptable values are:
- # - "`promotion`"
- "priceAdjustment": { # Adjustment for total price of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxAdjustment": { # Adjustment for total tax of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- },
- ],
- "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "cancellations": [ # Cancellations of the line item.
- {
- "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
- #
- # Acceptable values are:
- # - "`autoPostInternal`"
- # - "`autoPostInvalidBillingAddress`"
- # - "`autoPostNoInventory`"
- # - "`autoPostPriceError`"
- # - "`autoPostUndeliverableShippingAddress`"
- # - "`couponAbuse`"
- # - "`customerCanceled`"
- # - "`customerInitiatedCancel`"
- # - "`customerSupportRequested`"
- # - "`failToPushOrderGoogleError`"
- # - "`failToPushOrderMerchantError`"
- # - "`failToPushOrderMerchantFulfillmentError`"
- # - "`failToPushOrderToMerchant`"
- # - "`failToPushOrderToMerchantOutOfStock`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`merchantDidNotShipOnTime`"
- # - "`noInventory`"
- # - "`orderTimeout`"
- # - "`other`"
- # - "`paymentAbuse`"
- # - "`paymentDeclined`"
- # - "`priceError`"
- # - "`returnRefundAbuse`"
- # - "`shippingPriceError`"
- # - "`taxError`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the cancellation.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # The quantity that was canceled.
- },
- ],
- "quantityCanceled": 42, # Number of items canceled.
- "annotations": [ # Annotations that are attached to the line item.
- {
- "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
- "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
- },
- ],
- "returns": [ # Returns of the line item.
- {
- "reason": "A String", # The reason for the return.
- #
- # Acceptable values are:
- # - "`customerDiscretionaryReturn`"
- # - "`customerInitiatedMerchantCancel`"
- # - "`deliveredTooLate`"
- # - "`expiredItem`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`other`"
- # - "`productArrivedDamaged`"
- # - "`productNotAsDescribed`"
- # - "`qualityNotAsExpected`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- # - "`wrongProductShipped`"
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # Quantity that is returned.
- },
- ],
- "quantityShipped": 42, # Number of items shipped.
- "quantityReadyForPickup": 42, # Number of items ready for pickup.
- "quantityReturned": 42, # Number of items returned.
- "quantityUndeliverable": 42, # Number of items undeliverable.
- "id": "A String", # The ID of the line item.
- "shippingDetails": { # Details of the requested shipping for the line item.
- "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
- "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
- #
- # Acceptable values are:
- # - "`delivery`"
- # - "`pickup`"
- "method": { # Required. Details of the shipping method.
- "minDaysInTransit": 42, # Required. Minimum transit time.
- "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
- "methodName": "A String", # Required. The name of the shipping method.
- "maxDaysInTransit": 42, # Required. Maximum transit time.
- },
- "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
- },
- },
- ],
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "id": "A String", # The REST ID of the order. Globally unique.
- "deliveryDetails": { # Delivery details for shipments of type `delivery`.
- "phoneNumber": "A String", # The phone number of the person receiving the delivery.
- "address": { # The delivery address
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
+ # - "`marketplaceFacilitator`"
+ # - "`merchant`"
},
}</pre>
</div>
@@ -1591,171 +1591,171 @@
An object of the form:
{
- "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
- "template": { # The requested test order template.
- "promotions": [ # Promotions associated with the order.
+ "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
+ "template": { # The requested test order template.
+ "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.
{
- "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
- "title": "A String", # Required. The title of the promotion.
- "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
- "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`buyMGetMoneyOff`"
- # - "`buyMGetNMoneyOff`"
- # - "`buyMGetNPercentOff`"
- # - "`buyMGetPercentOff`"
- # - "`freeGift`"
- # - "`freeGiftWithItemId`"
- # - "`freeGiftWithValue`"
- # - "`freeShippingOvernight`"
- # - "`freeShippingStandard`"
- # - "`freeShippingTwoDay`"
- # - "`moneyOff`"
- # - "`percentOff`"
- # - "`rewardPoints`"
- # - "`salePrice`"
- "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
- {
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
- },
- ],
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
- {
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
- },
- ],
- "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`product`"
- # - "`shipping`"
- "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`google`"
- # - "`merchant`"
- },
- ],
- "predefinedEmail": "A String", # Required. Email address of the customer.
- #
- # Acceptable values are:
- # - "`pog.dwight.schrute@gmail.com`"
- # - "`pog.jim.halpert@gmail.com`"
- # - "`penpog.pam.beesly@gmail.comding`"
- "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
- "notificationMode": "A String", # Restricted. Do not use.
- "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
- #
- # Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
- "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "shippingOption": "A String", # Required. The requested shipping option.
- #
- # Acceptable values are:
- # - "`economy`"
- # - "`expedited`"
- # - "`oneDay`"
- # - "`sameDay`"
- # - "`standard`"
- # - "`twoDay`"
- "enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
- "lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
- {
- "returnInfo": { # Required. Details of the return policy for the line item.
- "policyUrl": "A String", # Required. URL of the item return policy.
- "isReturnable": True or False, # Required. Whether the item is returnable.
- "daysToReturn": 42, # Required. How many days later the item can be returned.
- },
- "product": { # Required. Product data from the time of the order placement.
- "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "product": { # Required. Product data from the time of the order placement.
+ "brand": "A String", # Required. Brand of the item.
+ "condition": "A String", # Required. Condition or state of the item.
#
# Acceptable values are:
- # - "`en`"
- # - "`fr`"
- "title": "A String", # Required. The title of the product.
- "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
- "variantAttributes": [ # Variant attributes for the item. Optional.
+ # - "`new`"
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ #
+ # Acceptable values are:
+ # - "`en`"
+ # - "`fr`"
+ "fees": [ # Fees for the item. Optional.
{
- "dimension": "A String", # The dimension of the variant.
- "value": "A String", # The value for the dimension.
- },
- ],
- "brand": "A String", # Required. Brand of the item.
- "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
- "offerId": "A String", # Required. An identifier of the item.
- "imageLink": "A String", # Required. URL of an image of the item.
- "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
- "fees": [ # Fees for the item. Optional.
- {
- "amount": { # Amount of the fee.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "amount": { # Amount of the fee.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "name": "A String", # Name of the fee.
+ "name": "A String", # Name of the fee.
},
],
- "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+ "imageLink": "A String", # Required. URL of an image of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+ "offerId": "A String", # Required. An identifier of the item.
+ "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "condition": "A String", # Required. Condition or state of the item.
- #
- # Acceptable values are:
- # - "`new`"
+ "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
+ "title": "A String", # Required. The title of the product.
+ "variantAttributes": [ # Variant attributes for the item. Optional.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
},
- "quantityOrdered": 42, # Required. Number of items ordered.
- "shippingDetails": { # Required. Details of the requested shipping for the line item.
- "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
- "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
+ "quantityOrdered": 42, # Required. Number of items ordered.
+ "returnInfo": { # Required. Details of the return policy for the line item.
+ "daysToReturn": 42, # Required. How many days later the item can be returned.
+ "isReturnable": True or False, # Required. Whether the item is returnable.
+ "policyUrl": "A String", # Required. URL of the item return policy.
+ },
+ "shippingDetails": { # Required. Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
+ "method": { # Required. Details of the shipping method.
+ "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
+ "maxDaysInTransit": 42, # Required. Maximum transit time.
+ "methodName": "A String", # Required. The name of the shipping method.
+ "minDaysInTransit": 42, # Required. Minimum transit time.
+ },
+ "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.
#
# Acceptable values are:
- # - "`delivery`"
- # - "`pickup`"
- "method": { # Required. Details of the shipping method.
- "minDaysInTransit": 42, # Required. Minimum transit time.
- "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
- "methodName": "A String", # Required. The name of the shipping method.
- "maxDaysInTransit": 42, # Required. Maximum transit time.
- },
- "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
+ # - "`delivery`"
+ # - "`pickup`"
},
},
],
- "predefinedBillingAddress": "A String", # Required. The billing address.
+ "notificationMode": "A String", # Restricted. Do not use.
+ "predefinedBillingAddress": "A String", # Required. The billing address.
#
# Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
- "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`pam`"
+ "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
#
# Acceptable values are:
- # - "`dwight`"
- # - "`jim`"
- # - "`pam`"
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`pam`"
+ "predefinedEmail": "A String", # Required. Email address of the customer.
+ #
+ # Acceptable values are:
+ # - "`pog.dwight.schrute@gmail.com`"
+ # - "`pog.jim.halpert@gmail.com`"
+ # - "`penpog.pam.beesly@gmail.comding`"
+ "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
+ #
+ # Acceptable values are:
+ # - "`dwight`"
+ # - "`jim`"
+ # - "`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.
+ {
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ {
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
+ },
+ ],
+ "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`google`"
+ # - "`merchant`"
+ "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
+ "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
+ "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`buyMGetMoneyOff`"
+ # - "`buyMGetNMoneyOff`"
+ # - "`buyMGetNPercentOff`"
+ # - "`buyMGetPercentOff`"
+ # - "`freeGift`"
+ # - "`freeGiftWithItemId`"
+ # - "`freeGiftWithValue`"
+ # - "`freeShippingOvernight`"
+ # - "`freeShippingStandard`"
+ # - "`freeShippingTwoDay`"
+ # - "`moneyOff`"
+ # - "`percentOff`"
+ # - "`rewardPoints`"
+ # - "`salePrice`"
+ "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "title": "A String", # Required. The title of the promotion.
+ "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`product`"
+ # - "`shipping`"
+ },
+ ],
+ "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingOption": "A String", # Required. The requested shipping option.
+ #
+ # Acceptable values are:
+ # - "`economy`"
+ # - "`expedited`"
+ # - "`oneDay`"
+ # - "`sameDay`"
+ # - "`standard`"
+ # - "`twoDay`"
},
}</pre>
</div>
@@ -1772,35 +1772,35 @@
The object takes the form of:
{
- "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "taxAmount": { # The amount of tax to be refunded. Required.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
- "reason": "A String", # The reason for the return.
+ "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity to return and refund.
+ "reason": "A String", # The reason for the return.
#
# Acceptable values are:
- # - "`customerDiscretionaryReturn`"
- # - "`customerInitiatedMerchantCancel`"
- # - "`deliveredTooLate`"
- # - "`expiredItem`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`other`"
- # - "`productArrivedDamaged`"
- # - "`productNotAsDescribed`"
- # - "`qualityNotAsExpected`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- # - "`wrongProductShipped`"
- "reasonText": "A String", # The explanation of the reason.
- "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
- "quantity": 42, # The quantity to return and refund.
- "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ # - "`customerDiscretionaryReturn`"
+ # - "`customerInitiatedMerchantCancel`"
+ # - "`deliveredTooLate`"
+ # - "`expiredItem`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`other`"
+ # - "`productArrivedDamaged`"
+ # - "`productNotAsDescribed`"
+ # - "`qualityNotAsExpected`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ # - "`wrongProductShipped`"
+ "reasonText": "A String", # The explanation of the reason.
+ "taxAmount": { # The amount of tax to be refunded. Required.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
}
@@ -1808,21 +1808,24 @@
An object of the form:
{
- "kind": "content#ordersInStoreRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersInStoreRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</code>
+ <code class="details" id="list">list(merchantId, acknowledged=None, maxResults=None, orderBy=None, pageToken=None, placedDateEnd=None, placedDateStart=None, statuses=None)</code>
<pre>Lists the orders 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)
+ acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
+We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
+ maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
orderBy: string, Order results by placement date in descending or ascending order.
Acceptable values are:
@@ -1830,9 +1833,6 @@
- placedDateDesc
pageToken: string, The token returned by the previous request.
placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
- acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
-We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
- maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
statuses: string, Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`. (repeated)
Allowed values
@@ -1852,28 +1852,295 @@
An object of the form:
{
- "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
- "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
- "resources": [
+ "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
+ "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
+ "resources": [
{ # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
- "customer": { # The details of the customer who placed the order.
- "loyaltyInfo": { # Loyalty program information.
- "loyaltyNumber": "A String", # The loyalty card/membership number.
- "name": "A String", # Name of card/membership holder, this field will be populated when
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "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:
+ # 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",
+ ],
+ },
+ "customer": { # The details of the customer who placed the order.
+ "fullName": "A String", # Full name of the customer.
+ "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
+ "loyaltyInfo": { # Loyalty program information.
+ "loyaltyNumber": "A String", # The loyalty card/membership number.
+ "name": "A String", # Name of card/membership holder, this field will be populated when
},
- "fullName": "A String", # Full name of the customer.
- "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
- "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
+ "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
+ "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
#
# Acceptable values are:
- # - "`denied`"
- # - "`granted`"
- "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
- "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
+ # - "`denied`"
+ # - "`granted`"
+ "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
+ "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
},
- "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
},
- "promotions": [ # Promotions associated with the order.
+ "deliveryDetails": { # Delivery details for shipments of type `delivery`.
+ "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.
+ },
+ "id": "A String", # The REST ID of the order. Globally unique.
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
+ "lineItems": [ # Line items that are ordered.
+ {
+ "adjustments": [ # Price and tax adjustments applied on the line item.
+ {
+ "priceAdjustment": { # Adjustment for total price of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "taxAdjustment": { # Adjustment for total tax of the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Type of this adjustment.
+ #
+ # Acceptable values are:
+ # - "`promotion`"
+ },
+ ],
+ "annotations": [ # Annotations that are attached to the line item.
+ {
+ "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
+ "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
+ },
+ ],
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "actor": "A String", # The actor that created the cancellation.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "quantity": 42, # The quantity that was canceled.
+ "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
+ #
+ # Acceptable values are:
+ # - "`autoPostInternal`"
+ # - "`autoPostInvalidBillingAddress`"
+ # - "`autoPostNoInventory`"
+ # - "`autoPostPriceError`"
+ # - "`autoPostUndeliverableShippingAddress`"
+ # - "`couponAbuse`"
+ # - "`customerCanceled`"
+ # - "`customerInitiatedCancel`"
+ # - "`customerSupportRequested`"
+ # - "`failToPushOrderGoogleError`"
+ # - "`failToPushOrderMerchantError`"
+ # - "`failToPushOrderMerchantFulfillmentError`"
+ # - "`failToPushOrderToMerchant`"
+ # - "`failToPushOrderToMerchantOutOfStock`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`merchantDidNotShipOnTime`"
+ # - "`noInventory`"
+ # - "`orderTimeout`"
+ # - "`other`"
+ # - "`paymentAbuse`"
+ # - "`paymentDeclined`"
+ # - "`priceError`"
+ # - "`returnRefundAbuse`"
+ # - "`shippingPriceError`"
+ # - "`taxError`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "id": "A String", # The ID of the line item.
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
+ "brand": "A String", # Brand of the item.
+ "condition": "A String", # Condition or state of the item.
+ #
+ # Acceptable values are:
+ # - "`new`"
+ # - "`refurbished`"
+ # - "`used`"
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "fees": [ # Associated fees at order creation time.
+ {
+ "amount": { # Amount of the fee.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "name": "A String", # Name of the fee.
+ },
+ ],
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "id": "A String", # The REST ID of the product.
+ "imageLink": "A String", # URL of an image of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "title": "A String", # The title 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.
+ },
+ ],
+ },
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityDelivered": 42, # Number of items delivered.
+ "quantityOrdered": 42, # Number of items ordered.
+ "quantityPending": 42, # Number of items pending.
+ "quantityReadyForPickup": 42, # Number of items ready for pickup.
+ "quantityReturned": 42, # Number of items returned.
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityUndeliverable": 42, # Number of items undeliverable.
+ "returnInfo": { # Details of the return policy for the line item.
+ "daysToReturn": 42, # Required. How many days later the item can be returned.
+ "isReturnable": True or False, # Required. Whether the item is returnable.
+ "policyUrl": "A String", # Required. URL of the item return policy.
+ },
+ "returns": [ # Returns of the line item.
+ {
+ "actor": "A String", # The actor that created the refund.
+ #
+ # Acceptable values are:
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "quantity": 42, # Quantity that is returned.
+ "reason": "A String", # The reason for the return.
+ #
+ # Acceptable values are:
+ # - "`customerDiscretionaryReturn`"
+ # - "`customerInitiatedMerchantCancel`"
+ # - "`deliveredTooLate`"
+ # - "`expiredItem`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`other`"
+ # - "`productArrivedDamaged`"
+ # - "`productNotAsDescribed`"
+ # - "`qualityNotAsExpected`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ # - "`wrongProductShipped`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
+ "method": { # Required. Details of the shipping method.
+ "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
+ "maxDaysInTransit": 42, # Required. Maximum transit time.
+ "methodName": "A String", # Required. The name of the shipping method.
+ "minDaysInTransit": 42, # Required. Minimum transit time.
+ },
+ "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.
+ #
+ # Acceptable values are:
+ # - "`delivery`"
+ # - "`pickup`"
+ },
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ },
+ ],
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided ID of the order.
+ "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "paymentStatus": "A String", # The status of the payment.
+ #
+ # Acceptable values are:
+ # - "`paymentCaptured`"
+ # - "`paymentRejected`"
+ # - "`paymentSecured`"
+ # - "`pendingAuthorization`"
+ "pickupDetails": { # Pickup details for shipments of type `pickup`.
+ "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
+ "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",
+ ],
+ },
+ "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
+ {
+ "name": "A String", # Name of the person picking up the shipment.
+ "phoneNumber": "A String", # Phone number of the person picking up the shipment.
+ },
+ ],
+ "locationId": "A String", # ID of the pickup location.
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "promotions": [ # Promotions associated with the order.
#
# To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
#
@@ -1885,485 +2152,218 @@
#
# More details about the program are here.
{
- "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
- "title": "A String", # Required. The title of the promotion.
- "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
- "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
- #
- # Acceptable values are:
- # - "`buyMGetMoneyOff`"
- # - "`buyMGetNMoneyOff`"
- # - "`buyMGetNPercentOff`"
- # - "`buyMGetPercentOff`"
- # - "`freeGift`"
- # - "`freeGiftWithItemId`"
- # - "`freeGiftWithValue`"
- # - "`freeShippingOvernight`"
- # - "`freeShippingStandard`"
- # - "`freeShippingTwoDay`"
- # - "`moneyOff`"
- # - "`percentOff`"
- # - "`rewardPoints`"
- # - "`salePrice`"
- "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
+ "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
+ "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
{
- "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
- "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
- "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
- "productId": "A String", # `orders.createtestorder`.
+ "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`.
+ "productId": "A String", # `orders.createtestorder`.
+ "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
},
],
- "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
- "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`product`"
- # - "`shipping`"
- "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
+ # - "`google`"
+ # - "`merchant`"
+ "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
+ "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
+ "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
+ "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
#
# Acceptable values are:
- # - "`google`"
- # - "`merchant`"
+ # - "`buyMGetMoneyOff`"
+ # - "`buyMGetNMoneyOff`"
+ # - "`buyMGetNPercentOff`"
+ # - "`buyMGetPercentOff`"
+ # - "`freeGift`"
+ # - "`freeGiftWithItemId`"
+ # - "`freeGiftWithValue`"
+ # - "`freeShippingOvernight`"
+ # - "`freeShippingStandard`"
+ # - "`freeShippingTwoDay`"
+ # - "`moneyOff`"
+ # - "`percentOff`"
+ # - "`rewardPoints`"
+ # - "`salePrice`"
+ "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "title": "A String", # Required. The title of the promotion.
+ "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
+ #
+ # Acceptable values are:
+ # - "`product`"
+ # - "`shipping`"
},
],
- "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
- "shippingCostTax": { # The tax for the total shipping cost.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "shipments": [ # Shipments of the order.
+ "refunds": [ # Refunds for the order.
{
- "status": "A String", # The status of the shipment.
+ "actor": "A String", # The actor that created the refund.
#
# Acceptable values are:
- # - "`delivered`"
- # - "`readyForPickup`"
- # - "`shipped`"
- # - "`undeliverable`"
- "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
- "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
- "carrier": "A String", # The carrier handling the shipment.
+ # - "`customer`"
+ # - "`googleBot`"
+ # - "`googleCustomerService`"
+ # - "`googlePayments`"
+ # - "`googleSabre`"
+ # - "`merchant`"
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ #
+ # 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`"
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "shipments": [ # Shipments of the order.
+ {
+ "carrier": "A String", # The carrier handling the shipment.
#
# For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
# Supported carriers for US are:
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`usps`" (United States Postal Service) automatic status updates
- # - "`fedex`" (FedEx) automatic status updates
- # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
- # - "`ontrac`" (OnTrac) automatic status updates
- # - "`dhl express`" (DHL Express)
- # - "`deliv`" (Deliv)
- # - "`dynamex`" (TForce)
- # - "`lasership`" (LaserShip)
- # - "`mpx`" (Military Parcel Xpress)
- # - "`uds`" (United Delivery Service)
- # - "`efw`" (Estes Forwarding Worldwide)
- # - "`jd logistics`" (JD Logistics)
- # - "`yunexpress`" (YunExpress)
- # - "`china post`" (China Post)
- # - "`china ems`" (China Post Express Mail Service)
- # - "`singapore post`" (Singapore Post)
- # - "`pos malaysia`" (Pos Malaysia)
- # - "`postnl`" (PostNL)
- # - "`ptt`" (PTT Turkish Post)
- # - "`eub`" (ePacket)
- # - "`chukou1`" (Chukou1 Logistics)
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`usps`" (United States Postal Service) automatic status updates
+ # - "`fedex`" (FedEx) automatic status updates
+ # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
+ # - "`ontrac`" (OnTrac) automatic status updates
+ # - "`dhl express`" (DHL Express)
+ # - "`deliv`" (Deliv)
+ # - "`dynamex`" (TForce)
+ # - "`lasership`" (LaserShip)
+ # - "`mpx`" (Military Parcel Xpress)
+ # - "`uds`" (United Delivery Service)
+ # - "`efw`" (Estes Forwarding Worldwide)
+ # - "`jd logistics`" (JD Logistics)
+ # - "`yunexpress`" (YunExpress)
+ # - "`china post`" (China Post)
+ # - "`china ems`" (China Post Express Mail Service)
+ # - "`singapore post`" (Singapore Post)
+ # - "`pos malaysia`" (Pos Malaysia)
+ # - "`postnl`" (PostNL)
+ # - "`ptt`" (PTT Turkish Post)
+ # - "`eub`" (ePacket)
+ # - "`chukou1`" (Chukou1 Logistics)
# Supported carriers for FR are:
- # - "`la poste`" (La Poste) automatic status updates
- # - "`colissimo`" (Colissimo by La Poste) automatic status updates
- # - "`ups`" (United Parcel Service) automatic status updates
- # - "`chronopost`" (Chronopost by La Poste)
- # - "`gls`" (General Logistics Systems France)
- # - "`dpd`" (DPD Group by GeoPost)
- # - "`bpost`" (Belgian Post Group)
- # - "`colis prive`" (Colis Privé)
- # - "`boxtal`" (Boxtal)
- # - "`geodis`" (GEODIS)
- # - "`tnt`" (TNT)
- # - "`db schenker`" (DB Schenker)
- # - "`aramex`" (Aramex)
- "trackingId": "A String", # The tracking ID for the shipment.
- "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
- "lineItems": [ # The line items that are shipped.
+ # - "`la poste`" (La Poste) automatic status updates
+ # - "`colissimo`" (Colissimo by La Poste) automatic status updates
+ # - "`ups`" (United Parcel Service) automatic status updates
+ # - "`chronopost`" (Chronopost by La Poste)
+ # - "`gls`" (General Logistics Systems France)
+ # - "`dpd`" (DPD Group by GeoPost)
+ # - "`bpost`" (Belgian Post Group)
+ # - "`colis prive`" (Colis Privé)
+ # - "`boxtal`" (Boxtal)
+ # - "`geodis`" (GEODIS)
+ # - "`tnt`" (TNT)
+ # - "`db schenker`" (DB Schenker)
+ # - "`aramex`" (Aramex)
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
+ "id": "A String", # The ID of the shipment.
+ "lineItems": [ # The line items that are shipped.
{
- "quantity": 42, # The quantity that is shipped.
- "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
+ "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity that is shipped.
},
],
- "id": "A String", # The ID of the shipment.
- },
- ],
- "refunds": [ # Refunds for the order.
- {
- "amount": { # The amount that is refunded.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reason": "A String", # The reason for the refund.
+ "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
+ "status": "A String", # The status of the shipment.
#
# 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`"
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "reasonText": "A String", # The explanation of the reason.
+ # - "`delivered`"
+ # - "`readyForPickup`"
+ # - "`shipped`"
+ # - "`undeliverable`"
+ "trackingId": "A String", # The tracking ID for the shipment.
},
],
- "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "status": "A String", # The status of the order.
#
# Acceptable values are:
- # - "`marketplaceFacilitator`"
- # - "`merchant`"
- "acknowledged": True or False, # Whether the order was acknowledged.
- "paymentStatus": "A String", # The status of the payment.
+ # - "`canceled`"
+ # - "`delivered`"
+ # - "`inProgress`"
+ # - "`partiallyDelivered`"
+ # - "`partiallyReturned`"
+ # - "`partiallyShipped`"
+ # - "`pendingShipment`"
+ # - "`returned`"
+ # - "`shipped`"
+ "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
#
# Acceptable values are:
- # - "`paymentCaptured`"
- # - "`paymentRejected`"
- # - "`paymentSecured`"
- # - "`pendingAuthorization`"
- "merchantId": "A String",
- "merchantOrderId": "A String", # Merchant-provided ID of the order.
- "status": "A String", # The status of the order.
- #
- # Acceptable values are:
- # - "`canceled`"
- # - "`delivered`"
- # - "`inProgress`"
- # - "`partiallyDelivered`"
- # - "`partiallyReturned`"
- # - "`partiallyShipped`"
- # - "`pendingShipment`"
- # - "`returned`"
- # - "`shipped`"
- "pickupDetails": { # Pickup details for shipments of type `pickup`.
- "locationId": "A String", # ID of the pickup location.
- "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
- {
- "phoneNumber": "A String", # Phone number of the person picking up the shipment.
- "name": "A String", # Name of the person picking up the shipment.
- },
- ],
- "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
- "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "billingAddress": { # The billing address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
- "lineItems": [ # Line items that are ordered.
- {
- "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
- "targetCountry": "A String", # The CLDR territory code of the target country of the product.
- "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
- "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
- "title": "A String", # The title of the product.
- "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
- "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.
- },
- ],
- "brand": "A String", # Brand of the item.
- "itemGroupId": "A String", # Shared identifier for all variants of the same product.
- "offerId": "A String", # An identifier of the item.
- "price": { # Price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "imageLink": "A String", # URL of an image of the item.
- "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
- "fees": [ # Associated fees at order creation time.
- {
- "amount": { # Amount of the fee.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "name": "A String", # Name of the fee.
- },
- ],
- "id": "A String", # The REST ID of the product.
- "condition": "A String", # Condition or state of the item.
- #
- # Acceptable values are:
- # - "`new`"
- # - "`refurbished`"
- # - "`used`"
- },
- "quantityPending": 42, # Number of items pending.
- "quantityDelivered": 42, # Number of items delivered.
- "returnInfo": { # Details of the return policy for the line item.
- "policyUrl": "A String", # Required. URL of the item return policy.
- "isReturnable": True or False, # Required. Whether the item is returnable.
- "daysToReturn": 42, # Required. How many days later the item can be returned.
- },
- "quantityOrdered": 42, # Number of items ordered.
- "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "adjustments": [ # Price and tax adjustments applied on the line item.
- {
- "type": "A String", # Type of this adjustment.
- #
- # Acceptable values are:
- # - "`promotion`"
- "priceAdjustment": { # Adjustment for total price of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "taxAdjustment": { # Adjustment for total tax of the line item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- },
- ],
- "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "cancellations": [ # Cancellations of the line item.
- {
- "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
- #
- # Acceptable values are:
- # - "`autoPostInternal`"
- # - "`autoPostInvalidBillingAddress`"
- # - "`autoPostNoInventory`"
- # - "`autoPostPriceError`"
- # - "`autoPostUndeliverableShippingAddress`"
- # - "`couponAbuse`"
- # - "`customerCanceled`"
- # - "`customerInitiatedCancel`"
- # - "`customerSupportRequested`"
- # - "`failToPushOrderGoogleError`"
- # - "`failToPushOrderMerchantError`"
- # - "`failToPushOrderMerchantFulfillmentError`"
- # - "`failToPushOrderToMerchant`"
- # - "`failToPushOrderToMerchantOutOfStock`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`merchantDidNotShipOnTime`"
- # - "`noInventory`"
- # - "`orderTimeout`"
- # - "`other`"
- # - "`paymentAbuse`"
- # - "`paymentDeclined`"
- # - "`priceError`"
- # - "`returnRefundAbuse`"
- # - "`shippingPriceError`"
- # - "`taxError`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the cancellation.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # The quantity that was canceled.
- },
- ],
- "quantityCanceled": 42, # Number of items canceled.
- "annotations": [ # Annotations that are attached to the line item.
- {
- "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
- "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
- },
- ],
- "returns": [ # Returns of the line item.
- {
- "reason": "A String", # The reason for the return.
- #
- # Acceptable values are:
- # - "`customerDiscretionaryReturn`"
- # - "`customerInitiatedMerchantCancel`"
- # - "`deliveredTooLate`"
- # - "`expiredItem`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`other`"
- # - "`productArrivedDamaged`"
- # - "`productNotAsDescribed`"
- # - "`qualityNotAsExpected`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- # - "`wrongProductShipped`"
- "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
- "reasonText": "A String", # The explanation of the reason.
- "actor": "A String", # The actor that created the refund.
- #
- # Acceptable values are:
- # - "`customer`"
- # - "`googleBot`"
- # - "`googleCustomerService`"
- # - "`googlePayments`"
- # - "`googleSabre`"
- # - "`merchant`"
- "quantity": 42, # Quantity that is returned.
- },
- ],
- "quantityShipped": 42, # Number of items shipped.
- "quantityReadyForPickup": 42, # Number of items ready for pickup.
- "quantityReturned": 42, # Number of items returned.
- "quantityUndeliverable": 42, # Number of items undeliverable.
- "id": "A String", # The ID of the line item.
- "shippingDetails": { # Details of the requested shipping for the line item.
- "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
- "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
- #
- # Acceptable values are:
- # - "`delivery`"
- # - "`pickup`"
- "method": { # Required. Details of the shipping method.
- "minDaysInTransit": 42, # Required. Minimum transit time.
- "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
- "methodName": "A String", # Required. The name of the shipping method.
- "maxDaysInTransit": 42, # Required. Maximum transit time.
- },
- "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
- },
- },
- ],
- "shippingCost": { # The total cost of shipping for all items.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "id": "A String", # The REST ID of the order. Globally unique.
- "deliveryDetails": { # Delivery details for shipments of type `delivery`.
- "phoneNumber": "A String", # The phone number of the person receiving the delivery.
- "address": { # The delivery address
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "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",
- ],
- "streetAddress": [ # Street-level part of the address.
- "A String",
- ],
- "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
- "recipientName": "A String", # Name of the recipient.
- "isPostOfficeBox": True or False, # Whether the address is a post office box.
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
+ # - "`marketplaceFacilitator`"
+ # - "`merchant`"
},
],
}</pre>
@@ -2378,7 +2378,7 @@
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
+ 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.
</pre>
</div>
@@ -2394,19 +2394,19 @@
The object takes the form of:
{
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
- "reason": "A String", # The reason for the return.
+ "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity to return and refund.
+ "reason": "A String", # The reason for the return.
#
# Acceptable values are:
- # - "`damagedOrUsed`"
- # - "`missingComponent`"
- # - "`notEligible`"
- # - "`other`"
- # - "`outOfReturnWindow`"
- "reasonText": "A String", # The explanation of the reason.
- "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
- "quantity": 42, # The quantity to return and refund.
+ # - "`damagedOrUsed`"
+ # - "`missingComponent`"
+ # - "`notEligible`"
+ # - "`other`"
+ # - "`outOfReturnWindow`"
+ "reasonText": "A String", # The explanation of the reason.
}
@@ -2414,12 +2414,12 @@
An object of the form:
{
- "kind": "content#ordersRejectReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersRejectReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".
}</pre>
</div>
@@ -2434,35 +2434,35 @@
The object takes the form of:
{
- "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "taxAmount": { # The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
- "reason": "A String", # The reason for the return.
+ "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity to return and refund.
+ "reason": "A String", # The reason for the return.
#
# Acceptable values are:
- # - "`customerDiscretionaryReturn`"
- # - "`customerInitiatedMerchantCancel`"
- # - "`deliveredTooLate`"
- # - "`expiredItem`"
- # - "`invalidCoupon`"
- # - "`malformedShippingAddress`"
- # - "`other`"
- # - "`productArrivedDamaged`"
- # - "`productNotAsDescribed`"
- # - "`qualityNotAsExpected`"
- # - "`undeliverableShippingAddress`"
- # - "`unsupportedPoBoxAddress`"
- # - "`wrongProductShipped`"
- "reasonText": "A String", # The explanation of the reason.
- "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
- "quantity": 42, # The quantity to return and refund.
- "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ # - "`customerDiscretionaryReturn`"
+ # - "`customerInitiatedMerchantCancel`"
+ # - "`deliveredTooLate`"
+ # - "`expiredItem`"
+ # - "`invalidCoupon`"
+ # - "`malformedShippingAddress`"
+ # - "`other`"
+ # - "`productArrivedDamaged`"
+ # - "`productNotAsDescribed`"
+ # - "`qualityNotAsExpected`"
+ # - "`undeliverableShippingAddress`"
+ # - "`unsupportedPoBoxAddress`"
+ # - "`wrongProductShipped`"
+ "reasonText": "A String", # The explanation of the reason.
+ "taxAmount": { # The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
}
@@ -2470,12 +2470,12 @@
An object of the form:
{
- "kind": "content#ordersReturnRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersReturnRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".
}</pre>
</div>
@@ -2490,15 +2490,15 @@
The object takes the form of:
{
- "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
- "annotations": [
+ "annotations": [
{
- "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
- "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
+ "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
+ "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
},
],
- "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
}
@@ -2506,12 +2506,12 @@
An object of the form:
{
- "kind": "content#ordersSetLineItemMetadataResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersSetLineItemMetadataResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".
}</pre>
</div>
@@ -2526,22 +2526,22 @@
The object takes the form of:
{
- "lineItems": [ # Line items to ship.
+ "lineItems": [ # Line items to ship.
{
- "quantity": 42, # The quantity that is shipped.
- "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
- "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
+ "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "quantity": 42, # The quantity that is shipped.
},
],
- "shipmentInfos": [ # Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderinvoices service.
+ "shipmentInfos": [ # Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
{
- "carrier": "A String", # The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.
- "trackingId": "A String", # The tracking ID for the shipment.
- "shipmentId": "A String", # Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
+ "carrier": "A String", # The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.
+ "shipmentId": "A String", # Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
+ "trackingId": "A String", # The tracking ID for the shipment.
},
],
- "shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderinvoices service.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
}
@@ -2549,12 +2549,12 @@
An object of the form:
{
- "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
}</pre>
</div>
@@ -2569,15 +2569,15 @@
The object takes the form of:
{
- "deliverByDate": "A String", # Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.
+ "deliverByDate": "A String", # Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.
#
# Provided date should be within 1 year timeframe and can not be a date in the past.
- "shipByDate": "A String", # Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.
+ "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
+ "shipByDate": "A String", # Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.
#
# Provided date should be within 1 year timeframe and can not be a date in the past.
- "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
- "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
}
@@ -2585,12 +2585,12 @@
An object of the form:
{
- "kind": "content#ordersUpdateLineItemShippingDetailsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersUpdateLineItemShippingDetailsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".
}</pre>
</div>
@@ -2605,8 +2605,8 @@
The object takes the form of:
{
- "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
}
@@ -2614,18 +2614,18 @@
An object of the form:
{
- "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="updateshipment">updateshipment(merchantId, orderId, body=None)</code>
- <pre>Updates a shipment's status, carrier, and/or tracking ID.
+ <pre>Updates a shipment's status, carrier, and/or tracking ID.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
@@ -2634,16 +2634,16 @@
The object takes the form of:
{
- "status": "A String", # New status for the shipment. Not updated if missing.
+ "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`.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "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`"
- "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.
- "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
- "shipmentId": "A String", # The ID of the shipment.
- "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`.
- "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ # - "`delivered`"
+ # - "`undeliverable`"
+ "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
}
@@ -2651,12 +2651,12 @@
An object of the form:
{
- "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
- "executionStatus": "A String", # The status of the execution.
+ "executionStatus": "A String", # The status of the execution.
#
# Acceptable values are:
- # - "`duplicate`"
- # - "`executed`"
+ # - "`duplicate`"
+ # - "`executed`"
+ "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
}</pre>
</div>