| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.orders.html">orders</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#acknowledge">acknowledge(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Marks an order as acknowledged.</p> |
| <p class="toc_element"> |
| <code><a href="#advancetestorder">advancetestorder(merchantId, orderId)</a></code></p> |
| <p class="firstline">Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".</p> |
| <p class="toc_element"> |
| <code><a href="#cancel">cancel(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Cancels all line items in an order, making a full refund.</p> |
| <p class="toc_element"> |
| <code><a href="#cancellineitem">cancellineitem(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Cancels a line item, making a full refund.</p> |
| <p class="toc_element"> |
| <code><a href="#canceltestorderbycustomer">canceltestorderbycustomer(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Sandbox only. Cancels a test order for customer-initiated cancellation.</p> |
| <p class="toc_element"> |
| <code><a href="#createtestorder">createtestorder(merchantId, body=None)</a></code></p> |
| <p class="firstline">Sandbox only. Creates a test order.</p> |
| <p class="toc_element"> |
| <code><a href="#createtestreturn">createtestreturn(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Sandbox only. Creates a test return.</p> |
| <p class="toc_element"> |
| <code><a href="#custombatch">custombatch(body=None)</a></code></p> |
| <p class="firstline">Retrieves or modifies multiple orders in a single request.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(merchantId, orderId)</a></code></p> |
| <p class="firstline">Retrieves an order from your Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</a></code></p> |
| <p class="firstline">Retrieves an order using merchant order ID.</p> |
| <p class="toc_element"> |
| <code><a href="#gettestordertemplate">gettestordertemplate(merchantId, templateName, country=None)</a></code></p> |
| <p class="firstline">Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.</p> |
| <p class="toc_element"> |
| <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, 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> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#refund">refund(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Deprecated, please use returnRefundLineItem instead.</p> |
| <p class="toc_element"> |
| <code><a href="#rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Rejects return on an line item.</p> |
| <p class="toc_element"> |
| <code><a href="#returnlineitem">returnlineitem(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Returns a line item.</p> |
| <p class="toc_element"> |
| <code><a href="#returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.</p> |
| <p class="toc_element"> |
| <code><a href="#setlineitemmetadata">setlineitemmetadata(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.</p> |
| <p class="toc_element"> |
| <code><a href="#shiplineitems">shiplineitems(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Marks line item(s) as shipped.</p> |
| <p class="toc_element"> |
| <code><a href="#updatelineitemshippingdetails">updatelineitemshippingdetails(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Updates ship by and delivery by dates for a line item.</p> |
| <p class="toc_element"> |
| <code><a href="#updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Updates the merchant order ID for a given order.</p> |
| <p class="toc_element"> |
| <code><a href="#updateshipment">updateshipment(merchantId, orderId, body=None)</a></code></p> |
| <p class="firstline">Updates a shipment's status, carrier, and/or tracking ID.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="acknowledge">acknowledge(merchantId, orderId, body=None)</code> |
| <pre>Marks an order as acknowledged. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`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`". |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the test order to modify. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="cancel">cancel(merchantId, orderId, body=None)</code> |
| <pre>Cancels all line items in an order, making a full refund. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order to cancel. (required) |
| body: object, The request body. |
| 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. |
| # |
| # Acceptable values are: |
| # - "`customerInitiatedCancel`" |
| # - "`invalidCoupon`" |
| # - "`malformedShippingAddress`" |
| # - "`noInventory`" |
| # - "`other`" |
| # - "`priceError`" |
| # - "`shippingPriceError`" |
| # - "`taxError`" |
| # - "`undeliverableShippingAddress`" |
| # - "`unsupportedPoBoxAddress`" |
| "reasonText": "A String", # The explanation of the reason. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="cancellineitem">cancellineitem(merchantId, orderId, body=None)</code> |
| <pre>Cancels a line item, making a full refund. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "amount": { # Deprecated. Please use amountPretax and amountTax instead. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountPretax": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax 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. |
| }, |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="canceltestorderbycustomer">canceltestorderbycustomer(merchantId, orderId, body=None)</code> |
| <pre>Sandbox only. Cancels a test order for customer-initiated cancellation. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the test order to cancel. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "reason": "A String", # The reason for the cancellation. |
| # |
| # Acceptable values are: |
| # - "`changedMind`" |
| # - "`orderedWrongItem`" |
| # - "`other`" |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "content#ordersCancelTestOrderByCustomerResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="createtestorder">createtestorder(merchantId, body=None)</code> |
| <pre>Sandbox only. Creates a test order. |
| |
| Args: |
| merchantId: string, The ID of the account that should manage the order. This cannot be a multi-client account. (required) |
| body: object, The request body. |
| 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`. |
| # |
| # Acceptable values are: |
| # - "`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. |
| "customer": { # Required. The details of the customer who placed the order. |
| "email": "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`" |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "fullName": "A String", # Full name of the customer. |
| "marketingRightsInfo": { # Customer's marketing preferences. |
| "explicitMarketingPreference": "A String", # Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. |
| # |
| # 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. |
| }, |
| }, |
| "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. |
| { |
| "product": { # Required. Product data from the time of the order placement. |
| "brand": "A String", # Required. Brand of the item. |
| "channel": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| "condition": "A String", # Required. Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`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. |
| { |
| "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. 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. |
| }, |
| "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. |
| "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`" |
| }, |
| "unitTax": { # Deprecated. Ignored if provided. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| }, |
| ], |
| "notificationMode": "A String", # Restricted. Do not use. |
| "paymentMethod": { # The details of the payment method. |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "predefinedBillingAddress": "A String", # The billing address. |
| # |
| # Acceptable values are: |
| # - "`dwight`" |
| # - "`jim`" |
| # - "`pam`" |
| "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by `createTestOrder`. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`MASTERCARD`" |
| # - "`VISA`" |
| }, |
| "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery. |
| # |
| # 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`. |
| # |
| # Acceptable values are: |
| # - "`dwight`" |
| # - "`jim`" |
| # - "`pam`" |
| "promotions": [ # Deprecated. Ignored if provided. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "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. |
| }, |
| "shippingCostTax": { # Deprecated. Ignored if provided. |
| "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`" |
| }, |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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> |
| |
| <div class="method"> |
| <code class="details" id="createtestreturn">createtestreturn(merchantId, orderId, body=None)</code> |
| <pre>Sandbox only. Creates a test return. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "items": [ # Returned items. |
| { |
| "lineItemId": "A String", # The ID of the line item to return. |
| "quantity": 42, # Quantity that is returned. |
| }, |
| ], |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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> |
| |
| <div class="method"> |
| <code class="details" id="custombatch">custombatch(body=None)</code> |
| <pre>Retrieves or modifies multiple orders in a single request. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "entries": [ # The request entries to be processed in the batch. |
| { |
| "batchId": 42, # An entry ID, unique within the batch request. |
| "cancel": { # Required for `cancel` method. |
| "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. |
| }, |
| "cancelLineItem": { # Required for `cancelLineItem` method. |
| "amount": { # Deprecated. Please use amountPretax and amountTax instead. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountPretax": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax 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. |
| }, |
| "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. |
| "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. |
| }, |
| "inStoreRefundLineItem": { # Required for `inStoreReturnLineItem` method. |
| "amountPretax": { # The amount that is refunded. Required. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that correspond to refund amount in amountPretax. 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. |
| "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. |
| }, |
| "merchantId": "A String", # The ID of the managing account. |
| "merchantOrderId": "A String", # The merchant order ID. Required for `updateMerchantOrderId` and `getByMerchantOrderId` methods. |
| "method": "A String", # The method of the batch entry. |
| # |
| # Acceptable values are: |
| # - "`acknowledge`" |
| # - "`cancel`" |
| # - "`cancelLineItem`" |
| # - "`get`" |
| # - "`getByMerchantOrderId`" |
| # - "`inStoreRefundLineItem`" |
| # - "`refund`" |
| # - "`rejectReturnLineItem`" |
| # - "`returnLineItem`" |
| # - "`returnRefundLineItem`" |
| # - "`setLineItemMetadata`" |
| # - "`shipLineItems`" |
| # - "`updateLineItemShippingDetails`" |
| # - "`updateMerchantOrderId`" |
| # - "`updateShipment`" |
| "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. Required for all methods beside `get` and `getByMerchantOrderId`. |
| "orderId": "A String", # The ID of the order. Required for all methods beside `getByMerchantOrderId`. |
| "refund": { # Required for `refund` method. |
| "amount": { # Deprecated. Please use amountPretax and amountTax instead. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountPretax": { # The amount that is refunded. Either amount or amountPretax should be filled. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax 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. |
| }, |
| "reason": "A String", # The reason for the refund. |
| # |
| # Acceptable values are: |
| # - "`adjustment`" |
| # - "`courtesyAdjustment`" |
| # - "`customerCanceled`" |
| # - "`customerDiscretionaryReturn`" |
| # - "`deliveredLateByCarrier`" |
| # - "`feeAdjustment`" |
| # - "`lateShipmentCredit`" |
| # - "`noInventory`" |
| # - "`other`" |
| # - "`priceError`" |
| # - "`productArrivedDamaged`" |
| # - "`productNotAsDescribed`" |
| # - "`shippingCostAdjustment`" |
| # - "`taxAdjustment`" |
| # - "`undeliverableShippingAddress`" |
| # - "`wrongProductShipped`" |
| "reasonText": "A String", # The explanation of the reason. |
| }, |
| "rejectReturnLineItem": { # Required for `rejectReturnLineItem` method. |
| "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. |
| "reason": "A String", # The reason for the return. |
| # |
| # Acceptable values are: |
| # - "`damagedOrUsed`" |
| # - "`missingComponent`" |
| # - "`notEligible`" |
| # - "`other`" |
| # - "`outOfReturnWindow`" |
| "reasonText": "A String", # The explanation of the reason. |
| }, |
| "returnLineItem": { # Required for `returnLineItem` method. |
| "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. |
| "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. |
| }, |
| "returnRefundLineItem": { # Required for `returnRefundLineItem` method. |
| "amountPretax": { # The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax 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. |
| }, |
| "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. |
| "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. |
| }, |
| "setLineItemMetadata": { # Required for `setLineItemMetadata` method. |
| "annotations": [ |
| { |
| "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. |
| "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. |
| }, |
| "shipLineItems": { # Required for `shipLineItems` method. |
| "carrier": "A String", # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. |
| "lineItems": [ # Line items to ship. |
| { |
| "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. |
| }, |
| ], |
| "shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderinvoices service. |
| "shipmentId": "A String", # Deprecated. Please use shipmentInfo instead. The ID of the shipment. |
| "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. |
| "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. |
| }, |
| ], |
| "trackingId": "A String", # Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. |
| }, |
| "updateLineItemShippingDetails": { # Required for `updateLineItemShippingDate` method. |
| "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. |
| "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required. |
| "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. |
| }, |
| "updateShipment": { # Required for `updateShipment` method. |
| "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`. |
| "shipmentId": "A String", # The ID of the shipment. |
| "status": "A String", # New status for the shipment. Not updated if missing. |
| # |
| # Acceptable values are: |
| # - "`delivered`" |
| # - "`undeliverable`" |
| # - "`readyForPickup`" |
| "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing. |
| }, |
| }, |
| ], |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "entries": [ # The result of the execution of the batch requests. |
| { |
| "batchId": 42, # The ID of the request entry this entry responds to. |
| "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. |
| "code": 42, # The HTTP status of the first error in `errors`. |
| "errors": [ # A list of errors. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| "message": "A String", # The message of the first error in `errors`. |
| }, |
| "executionStatus": "A String", # The status of the execution. Only defined if |
| # - the request was successful; and |
| # - the method is not `get`, `getByMerchantOrderId`, or one of the test methods. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#ordersCustomBatchResponseEntry`" |
| "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 retrieved order. Only defined if the method is `get` and if the request was successful. |
| "acknowledged": True or False, # Whether the order was acknowledged. |
| "channelType": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`googleExpress`" |
| # - "`purchasesOnGoogle`" |
| "customer": { # The details of the customer who placed the order. |
| "email": "A String", # Deprecated. |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "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. |
| "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. |
| }, |
| }, |
| "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. |
| { |
| "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. |
| "channel": "A String", # The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "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. |
| "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. |
| "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $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. |
| }, |
| "paymentMethod": { # The details of the payment method. |
| "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", |
| ], |
| }, |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "phoneNumber": "A String", # The billing phone number. |
| "type": "A String", # The type of instrument. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`JCB`" |
| # - "`MASTERCARD`" |
| # - "`UNIONPAY`" |
| # - "`VISA`" |
| # - "``" |
| }, |
| "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": [ # The details of the merchant provided promotions applied to the order. |
| # |
| # To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` 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`. |
| # |
| # Examples: |
| # - To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. |
| # - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. |
| # |
| # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. |
| # |
| # More details about the program are here. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "refunds": [ # Refunds for the order. |
| { |
| "actor": "A String", # The actor that created the refund. |
| # |
| # Acceptable values are: |
| # - "`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) |
| # 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) |
| "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. |
| { |
| "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. |
| }, |
| ], |
| "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed. |
| "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery. |
| "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format. |
| }, |
| "status": "A String", # The status of the shipment. |
| # |
| # Acceptable values are: |
| # - "`delivered`" |
| # - "`readyForPickup`" |
| # - "`shipped`" |
| # - "`undeliverable`" |
| "trackingId": "A String", # The tracking ID for the shipment. |
| }, |
| ], |
| "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. |
| }, |
| "shippingOption": "A String", # Deprecated. Shipping details are provided with line items instead. |
| # |
| # Acceptable values are: |
| # - "`economy`" |
| # - "`expedited`" |
| # - "`oneDay`" |
| # - "`sameDay`" |
| # - "`standard`" |
| # - "`twoDay`" |
| "status": "A String", # The status of the order. |
| # |
| # Acceptable values are: |
| # - "`canceled`" |
| # - "`delivered`" |
| # - "`inProgress`" |
| # - "`partiallyDelivered`" |
| # - "`partiallyReturned`" |
| # - "`partiallyShipped`" |
| # - "`pendingShipment`" |
| # - "`returned`" |
| # - "`shipped`" |
| "taxCollector": "A String", # The party responsible for collecting and remitting taxes. |
| # |
| # Acceptable values are: |
| # - "`marketplaceFacilitator`" |
| # - "`merchant`" |
| }, |
| }, |
| ], |
| "kind": "content#ordersCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(merchantId, orderId)</code> |
| <pre>Retrieves an order from your Merchant Center account. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| |
| Returns: |
| 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 ==) |
| "acknowledged": True or False, # Whether the order was acknowledged. |
| "channelType": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`googleExpress`" |
| # - "`purchasesOnGoogle`" |
| "customer": { # The details of the customer who placed the order. |
| "email": "A String", # Deprecated. |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "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. |
| "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. |
| }, |
| }, |
| "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. |
| { |
| "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. |
| "channel": "A String", # The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "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. |
| "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. |
| "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $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. |
| }, |
| "paymentMethod": { # The details of the payment method. |
| "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", |
| ], |
| }, |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "phoneNumber": "A String", # The billing phone number. |
| "type": "A String", # The type of instrument. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`JCB`" |
| # - "`MASTERCARD`" |
| # - "`UNIONPAY`" |
| # - "`VISA`" |
| # - "``" |
| }, |
| "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": [ # The details of the merchant provided promotions applied to the order. |
| # |
| # To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` 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`. |
| # |
| # Examples: |
| # - To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. |
| # - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. |
| # |
| # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. |
| # |
| # More details about the program are here. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "refunds": [ # Refunds for the order. |
| { |
| "actor": "A String", # The actor that created the refund. |
| # |
| # Acceptable values are: |
| # - "`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) |
| # 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) |
| "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. |
| { |
| "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. |
| }, |
| ], |
| "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed. |
| "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery. |
| "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format. |
| }, |
| "status": "A String", # The status of the shipment. |
| # |
| # Acceptable values are: |
| # - "`delivered`" |
| # - "`readyForPickup`" |
| # - "`shipped`" |
| # - "`undeliverable`" |
| "trackingId": "A String", # The tracking ID for the shipment. |
| }, |
| ], |
| "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. |
| }, |
| "shippingOption": "A String", # Deprecated. Shipping details are provided with line items instead. |
| # |
| # Acceptable values are: |
| # - "`economy`" |
| # - "`expedited`" |
| # - "`oneDay`" |
| # - "`sameDay`" |
| # - "`standard`" |
| # - "`twoDay`" |
| "status": "A String", # The status of the order. |
| # |
| # Acceptable values are: |
| # - "`canceled`" |
| # - "`delivered`" |
| # - "`inProgress`" |
| # - "`partiallyDelivered`" |
| # - "`partiallyReturned`" |
| # - "`partiallyShipped`" |
| # - "`pendingShipment`" |
| # - "`returned`" |
| # - "`shipped`" |
| "taxCollector": "A String", # The party responsible for collecting and remitting taxes. |
| # |
| # Acceptable values are: |
| # - "`marketplaceFacilitator`" |
| # - "`merchant`" |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</code> |
| <pre>Retrieves an order using merchant order ID. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| merchantOrderId: string, The merchant order ID to be looked for. (required) |
| |
| Returns: |
| 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. |
| "acknowledged": True or False, # Whether the order was acknowledged. |
| "channelType": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`googleExpress`" |
| # - "`purchasesOnGoogle`" |
| "customer": { # The details of the customer who placed the order. |
| "email": "A String", # Deprecated. |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "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. |
| "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. |
| }, |
| }, |
| "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. |
| { |
| "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. |
| "channel": "A String", # The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "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. |
| "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. |
| "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $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. |
| }, |
| "paymentMethod": { # The details of the payment method. |
| "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", |
| ], |
| }, |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "phoneNumber": "A String", # The billing phone number. |
| "type": "A String", # The type of instrument. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`JCB`" |
| # - "`MASTERCARD`" |
| # - "`UNIONPAY`" |
| # - "`VISA`" |
| # - "``" |
| }, |
| "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": [ # The details of the merchant provided promotions applied to the order. |
| # |
| # To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` 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`. |
| # |
| # Examples: |
| # - To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. |
| # - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. |
| # |
| # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. |
| # |
| # More details about the program are here. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "refunds": [ # Refunds for the order. |
| { |
| "actor": "A String", # The actor that created the refund. |
| # |
| # Acceptable values are: |
| # - "`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) |
| # 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) |
| "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. |
| { |
| "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. |
| }, |
| ], |
| "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed. |
| "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery. |
| "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format. |
| }, |
| "status": "A String", # The status of the shipment. |
| # |
| # Acceptable values are: |
| # - "`delivered`" |
| # - "`readyForPickup`" |
| # - "`shipped`" |
| # - "`undeliverable`" |
| "trackingId": "A String", # The tracking ID for the shipment. |
| }, |
| ], |
| "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. |
| }, |
| "shippingOption": "A String", # Deprecated. Shipping details are provided with line items instead. |
| # |
| # Acceptable values are: |
| # - "`economy`" |
| # - "`expedited`" |
| # - "`oneDay`" |
| # - "`sameDay`" |
| # - "`standard`" |
| # - "`twoDay`" |
| "status": "A String", # The status of the order. |
| # |
| # Acceptable values are: |
| # - "`canceled`" |
| # - "`delivered`" |
| # - "`inProgress`" |
| # - "`partiallyDelivered`" |
| # - "`partiallyReturned`" |
| # - "`partiallyShipped`" |
| # - "`pendingShipment`" |
| # - "`returned`" |
| # - "`shipped`" |
| "taxCollector": "A String", # The party responsible for collecting and remitting taxes. |
| # |
| # Acceptable values are: |
| # - "`marketplaceFacilitator`" |
| # - "`merchant`" |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="gettestordertemplate">gettestordertemplate(merchantId, templateName, country=None)</code> |
| <pre>Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. |
| |
| Args: |
| merchantId: string, The ID of the account that should manage the order. This cannot be a multi-client account. (required) |
| templateName: string, The name of the template to retrieve. (required) |
| Allowed values |
| template1 - |
| template1a - |
| template1b - |
| template2 - |
| template3 - |
| country: string, The country of the template to retrieve. Defaults to `US`. |
| |
| Returns: |
| 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. |
| "customer": { # Required. The details of the customer who placed the order. |
| "email": "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`" |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "fullName": "A String", # Full name of the customer. |
| "marketingRightsInfo": { # Customer's marketing preferences. |
| "explicitMarketingPreference": "A String", # Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. |
| # |
| # 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. |
| }, |
| }, |
| "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. |
| { |
| "product": { # Required. Product data from the time of the order placement. |
| "brand": "A String", # Required. Brand of the item. |
| "channel": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| "condition": "A String", # Required. Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`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. |
| { |
| "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. 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. |
| }, |
| "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. |
| "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`" |
| }, |
| "unitTax": { # Deprecated. Ignored if provided. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| }, |
| ], |
| "notificationMode": "A String", # Restricted. Do not use. |
| "paymentMethod": { # The details of the payment method. |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "predefinedBillingAddress": "A String", # The billing address. |
| # |
| # Acceptable values are: |
| # - "`dwight`" |
| # - "`jim`" |
| # - "`pam`" |
| "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by `createTestOrder`. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`MASTERCARD`" |
| # - "`VISA`" |
| }, |
| "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery. |
| # |
| # 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`. |
| # |
| # Acceptable values are: |
| # - "`dwight`" |
| # - "`jim`" |
| # - "`pam`" |
| "promotions": [ # Deprecated. Ignored if provided. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "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. |
| }, |
| "shippingCostTax": { # Deprecated. Ignored if provided. |
| "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> |
| |
| <div class="method"> |
| <code class="details" id="instorerefundlineitem">instorerefundlineitem(merchantId, orderId, body=None)</code> |
| <pre>Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). |
| Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "amountPretax": { # The amount that is refunded. Required. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that correspond to refund amount in amountPretax. 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. |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`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, 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: |
| - placedDateAsc |
| - placedDateDesc |
| pageToken: string, The token returned by the previous request. |
| placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format. |
| 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 |
| active - |
| canceled - |
| completed - |
| delivered - |
| inProgress - |
| partiallyDelivered - |
| partiallyReturned - |
| partiallyShipped - |
| pendingShipment - |
| returned - |
| shipped - |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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 ==) |
| "acknowledged": True or False, # Whether the order was acknowledged. |
| "channelType": "A String", # Deprecated. |
| # |
| # Acceptable values are: |
| # - "`googleExpress`" |
| # - "`purchasesOnGoogle`" |
| "customer": { # The details of the customer who placed the order. |
| "email": "A String", # Deprecated. |
| "explicitMarketingPreference": True or False, # Deprecated. Please use marketingRightsInfo instead. |
| "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. |
| "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. |
| }, |
| }, |
| "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. |
| { |
| "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. |
| "channel": "A String", # The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "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. |
| "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. |
| "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $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. |
| }, |
| "paymentMethod": { # The details of the payment method. |
| "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", |
| ], |
| }, |
| "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.). |
| "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015). |
| "lastFourDigits": "A String", # The last four digits of the card number. |
| "phoneNumber": "A String", # The billing phone number. |
| "type": "A String", # The type of instrument. |
| # |
| # Acceptable values are: |
| # - "`AMEX`" |
| # - "`DISCOVER`" |
| # - "`JCB`" |
| # - "`MASTERCARD`" |
| # - "`UNIONPAY`" |
| # - "`VISA`" |
| # - "``" |
| }, |
| "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": [ # The details of the merchant provided promotions applied to the order. |
| # |
| # To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` 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`. |
| # |
| # Examples: |
| # - To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. |
| # - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. |
| # |
| # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. |
| # |
| # More details about the program are here. |
| { |
| "benefits": [ |
| { |
| "discount": { # The discount in the order price when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. |
| "A String", |
| ], |
| "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. |
| # |
| # Acceptable values are: |
| # - "`buyMGetMoneyOff`" |
| # - "`buyMGetNMoneyOff`" |
| # - "`buyMGetNPercentOff`" |
| # - "`buyMGetPercentOff`" |
| # - "`freeGift`" |
| # - "`freeGiftWithItemId`" |
| # - "`freeGiftWithValue`" |
| # - "`freeOvernightShipping`" |
| # - "`freeShipping`" |
| # - "`freeTwoDayShipping`" |
| # - "`moneyOff`" |
| # - "`percentageOff`" |
| # - "`rewardPoints`" |
| # - "`salePrice`" |
| "taxImpact": { # The impact on tax when the promotion is applied. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). |
| # |
| # Acceptable values are: |
| # - "`product`" |
| # - "`shipping`" |
| }, |
| ], |
| "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. |
| # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. |
| "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website. |
| "id": "A String", # The unique ID of the promotion. |
| "longTitle": "A String", # The full title of the promotion. |
| "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products. |
| # |
| # Acceptable values are: |
| # - "`allProducts`" |
| # - "`specificProducts`" |
| "redemptionChannel": "A String", # Indicates that the promotion is valid online. |
| # |
| # Acceptable values are: |
| # - "`online`" |
| }, |
| ], |
| "refunds": [ # Refunds for the order. |
| { |
| "actor": "A String", # The actor that created the refund. |
| # |
| # Acceptable values are: |
| # - "`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) |
| # 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) |
| "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. |
| { |
| "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. |
| }, |
| ], |
| "scheduledDeliveryDetails": { # Delivery details of the shipment if scheduling is needed. |
| "carrierPhoneNumber": "A String", # The phone number of the carrier fulfilling the delivery. |
| "scheduledDate": "A String", # The date a shipment is scheduled for delivery, in ISO 8601 format. |
| }, |
| "status": "A String", # The status of the shipment. |
| # |
| # Acceptable values are: |
| # - "`delivered`" |
| # - "`readyForPickup`" |
| # - "`shipped`" |
| # - "`undeliverable`" |
| "trackingId": "A String", # The tracking ID for the shipment. |
| }, |
| ], |
| "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. |
| }, |
| "shippingOption": "A String", # Deprecated. Shipping details are provided with line items instead. |
| # |
| # Acceptable values are: |
| # - "`economy`" |
| # - "`expedited`" |
| # - "`oneDay`" |
| # - "`sameDay`" |
| # - "`standard`" |
| # - "`twoDay`" |
| "status": "A String", # The status of the order. |
| # |
| # Acceptable values are: |
| # - "`canceled`" |
| # - "`delivered`" |
| # - "`inProgress`" |
| # - "`partiallyDelivered`" |
| # - "`partiallyReturned`" |
| # - "`partiallyShipped`" |
| # - "`pendingShipment`" |
| # - "`returned`" |
| # - "`shipped`" |
| "taxCollector": "A String", # The party responsible for collecting and remitting taxes. |
| # |
| # Acceptable values are: |
| # - "`marketplaceFacilitator`" |
| # - "`merchant`" |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="refund">refund(merchantId, orderId, body=None)</code> |
| <pre>Deprecated, please use returnRefundLineItem instead. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order to refund. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "amount": { # Deprecated. Please use amountPretax and amountTax instead. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountPretax": { # The amount that is refunded. Either amount or amountPretax should be filled. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax 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 refund. |
| # |
| # Acceptable values are: |
| # - "`adjustment`" |
| # - "`courtesyAdjustment`" |
| # - "`customerCanceled`" |
| # - "`customerDiscretionaryReturn`" |
| # - "`deliveredLateByCarrier`" |
| # - "`feeAdjustment`" |
| # - "`lateShipmentCredit`" |
| # - "`noInventory`" |
| # - "`other`" |
| # - "`priceError`" |
| # - "`productArrivedDamaged`" |
| # - "`productNotAsDescribed`" |
| # - "`shippingCostAdjustment`" |
| # - "`taxAdjustment`" |
| # - "`undeliverableShippingAddress`" |
| # - "`wrongProductShipped`" |
| "reasonText": "A String", # The explanation of the reason. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</code> |
| <pre>Rejects return on an line item. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersRejectReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="returnlineitem">returnlineitem(merchantId, orderId, body=None)</code> |
| <pre>Returns a line item. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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. |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</code> |
| <pre>Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "amountPretax": { # The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "amountTax": { # Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax 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. |
| }, |
| "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: |
| # - "`customerDiscretionaryReturn`" |
| # - "`customerInitiatedMerchantCancel`" |
| # - "`deliveredTooLate`" |
| # - "`expiredItem`" |
| # - "`invalidCoupon`" |
| # - "`malformedShippingAddress`" |
| # - "`other`" |
| # - "`productArrivedDamaged`" |
| # - "`productNotAsDescribed`" |
| # - "`qualityNotAsExpected`" |
| # - "`undeliverableShippingAddress`" |
| # - "`unsupportedPoBoxAddress`" |
| # - "`wrongProductShipped`" |
| "reasonText": "A String", # The explanation of the reason. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersReturnRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setlineitemmetadata">setlineitemmetadata(merchantId, orderId, body=None)</code> |
| <pre>Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "annotations": [ |
| { |
| "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. |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersSetLineItemMetadataResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="shiplineitems">shiplineitems(merchantId, orderId, body=None)</code> |
| <pre>Marks line item(s) as shipped. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "carrier": "A String", # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. |
| "lineItems": [ # Line items to ship. |
| { |
| "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. |
| }, |
| ], |
| "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. |
| "shipmentId": "A String", # Deprecated. Please use shipmentInfo instead. The ID of the shipment. |
| "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. |
| "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. |
| }, |
| ], |
| "trackingId": "A String", # Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updatelineitemshippingdetails">updatelineitemshippingdetails(merchantId, orderId, body=None)</code> |
| <pre>Updates ship by and delivery by dates for a line item. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| 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. |
| # |
| # Provided date should be within 1 year timeframe and can not be a date in the past. |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersUpdateLineItemShippingDetailsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body=None)</code> |
| <pre>Updates the merchant order ID for a given order. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| 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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`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. |
| |
| Args: |
| merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| orderId: string, The ID of the order. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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`" |
| # - "`readyForPickup`" |
| "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "executionStatus": "A String", # The status of the execution. |
| # |
| # Acceptable values are: |
| # - "`duplicate`" |
| # - "`executed`" |
| "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". |
| }</pre> |
| </div> |
| |
| </body></html> |
