Lines Matching full:the
115 <p class="firstline">Lists the orders in your Merchant Center account.</p>
118 <p class="firstline">Retrieves the next page of results.</p>
133 …the form of key-value pairs. A common use case would be to supply us with additional structured in…
142 <p class="firstline">Updates the merchant order ID for a given order.</p>
152 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
153 orderId: string, The ID of the order. (required)
154 body: object, The request body. (required)
155 The object takes the form of:
158 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
163 An object of the form:
166 …rsAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
167 "executionStatus": "A String", # The status of the execution.
176 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
177 orderId: string, The ID of the test order to modify. (required)
180 An object of the form:
183 …anceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
192 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
193 orderId: string, The ID of the order to cancel. (required)
194 body: object, The request body. (required)
195 The object takes the form of:
198 "reason": "A String", # The reason for the cancellation.
199 "reasonText": "A String", # The explanation of the reason.
200 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
205 An object of the form:
208 …"kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fix…
209 "executionStatus": "A String", # The status of the execution.
218 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
219 orderId: string, The ID of the order. (required)
220 body: object, The request body. (required)
221 The object takes the form of:
224 "quantity": 42, # The quantity to cancel.
225 …the cancelation. Optional. If not set, Google will calculate the default based on the price and ta…
226 "currency": "A String", # The currency of the price.
227 "value": "A String", # The price represented as a number.
230 "currency": "A String", # The currency of the price.
231 "value": "A String", # The price represented as a number.
233 "reasonText": "A String", # The explanation of the reason.
234 …"lineItemId": "A String", # The ID of the line item to cancel. Either lineItemId or productId is r…
235 "reason": "A String", # The reason for the cancellation.
237 "currency": "A String", # The currency of the price.
238 "value": "A String", # The price represented as a number.
240 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
241 …"productId": "A String", # The ID of the product to cancel. This is the REST ID used in the produc…
246 An object of the form:
249 …ancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
250 "executionStatus": "A String", # The status of the execution.
259 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
260 orderId: string, The ID of the test order to cancel. (required)
261 body: object, The request body. (required)
262 The object takes the form of:
265 "reason": "A String", # The reason for the cancellation.
270 An object of the form:
273 …derByCustomerResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
282 …merchantId: string, The ID of the account that should manage the order. This cannot be a multi-cli…
283 body: object, The request body. (required)
284 The object takes the form of:
287 … # The CLDR territory code of the country of the test order to create. Affects the currency and a…
292 "testOrder": { # The test order to create.
293 "customer": { # The details of the customer who placed the order.
295 "fullName": "A String", # Full name of the customer.
296 "email": "A String", # Email address of the customer.
306 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
309 "discount": { # The discount in the order price when the promotion is applied.
310 "currency": "A String", # The currency of the price.
311 "value": "A String", # The price represented as a number.
313 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
314 "taxImpact": { # The impact on tax when the promotion is applied.
315 "currency": "A String", # The currency of the price.
316 "value": "A String", # The price represented as a number.
318 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
321 "longTitle": "A String", # The full title of the promotion.
322 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
323 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
324 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
325 …The date and time frame when the promotion is active and ready for validation review. Note that th…
326 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
327 "id": "A String", # The unique ID of the promotion.
330 …"kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "…
332 "currency": "A String", # The currency of the price.
333 "value": "A String", # The price represented as a number.
336 …nedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the …
337 …"shippingCost": { # The price of shipping for all items. Shipping tax is automatically calculated …
338 "currency": "A String", # The currency of the price.
339 "value": "A String", # The price represented as a number.
341 "shippingOption": "A String", # The requested shipping option.
342 …"enableOrderinvoices": True or False, # Whether the orderinvoices service should support this orde…
345 "returnInfo": { # Details of the return policy for the line item.
346 "policyUrl": "A String", # URL of the item return policy.
347 "isReturnable": True or False, # Whether the item is returnable.
348 "daysToReturn": 42, # How many days later the item can be returned.
350 "product": { # Product data from the time of the order placement.
351 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
352 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
353 "title": "A String", # The title of the product.
354 "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
355 "variantAttributes": [ # Variant attributes for the item. Optional.
357 "dimension": "A String", # The dimension of the variant.
358 "value": "A String", # The value for the dimension.
361 "brand": "A String", # Brand of the item.
362 … "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
363 "offerId": "A String", # An identifier of the item.
364 "imageLink": "A String", # URL of an image of the item.
365 "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
367 "fees": [ # Fees for the item. Optional.
369 "amount": { # Amount of the fee.
370 "currency": "A String", # The currency of the price.
371 "value": "A String", # The price represented as a number.
373 "name": "A String", # Name of the fee.
376 …"price": { # The price for the product. Tax is automatically calculated for MFL orders. For non-MF…
377 "currency": "A String", # The currency of the price.
378 "value": "A String", # The price represented as a number.
380 "condition": "A String", # Condition or state of the item.
383 "currency": "A String", # The currency of the price.
384 "value": "A String", # The price represented as a number.
387 "shippingDetails": { # Details of the requested shipping for the line item.
388 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
389 "method": { # Details of the shipping method.
391 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
392 "methodName": "A String", # The name of the shipping method.
395 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
399 "paymentMethod": { # The details of the payment method.
400 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
401 …"type": "A String", # The type of instrument. Note that real orders might have different values th…
402 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
403 "lastFourDigits": "A String", # The last four digits of the card number.
404 "predefinedBillingAddress": "A String", # The billing address.
407 …"templateName": "A String", # The test order template to use. Specify as an alternative to testOrd…
412 An object of the form:
415 "orderId": "A String", # The ID of the newly created test order.
416 …eateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
425 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
426 orderId: string, The ID of the order. (required)
427 body: object, The request body. (required)
428 The object takes the form of:
433 "lineItemId": "A String", # The ID of the line item to return.
441 An object of the form:
444 "returnId": "A String", # The ID of the newly created test order return.
445 …ateTestReturnResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
454 body: object, The request body. (required)
455 The object takes the form of:
458 "entries": [ # The request entries to be processed in the batch.
460 …"orderId": "A String", # The ID of the order. Required for all methods beside getByMerchantOrderId.
461 …"merchantOrderId": "A String", # The merchant order ID. Required for updateMerchantOrderId and get…
463 …"amountPretax": { # The amount that is refunded. If omitted, refundless return is assumed (same as…
464 "currency": "A String", # The currency of the price.
465 "value": "A String", # The price represented as a number.
467 "reason": "A String", # The reason for the return.
468 "reasonText": "A String", # The explanation of the reason.
469 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
471 "currency": "A String", # The currency of the price.
472 "value": "A String", # The price represented as a number.
474 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
475 "quantity": 42, # The quantity to return and refund.
478 "reason": "A String", # The reason for the return.
479 "quantity": 42, # The quantity to return and refund.
480 "reasonText": "A String", # The explanation of the reason.
481 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
482 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
487 # Provided date should be within 1 year timeframe and can not be a date in the past.
490 # Provided date should be within 1 year timeframe and can not be a date in the past.
491 …"lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productI…
492 …"productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the …
495 "amountPretax": { # The amount that is refunded. Required.
496 "currency": "A String", # The currency of the price.
497 "value": "A String", # The price represented as a number.
499 "reason": "A String", # The reason for the return.
500 "reasonText": "A String", # The explanation of the reason.
501 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
503 "currency": "A String", # The currency of the price.
504 "value": "A String", # The price represented as a number.
506 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
507 "quantity": 42, # The quantity to return and refund.
510 …"shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderi…
513 …"carrier": "A String", # The carrier handling the shipment. See shipments[].carrier in the Orders…
514 "trackingId": "A String", # The tracking ID for the shipment.
515 …"shipmentId": "A String", # The ID of the shipment. This is assigned by the merchant and is unique…
518 …eprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].car…
519 …ngId": "A String", # Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.
520 … "shipmentId": "A String", # Deprecated. Please use shipmentInfo instead. The ID of the shipment.
523 "quantity": 42, # The quantity that is shipped.
524 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
525 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
530 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. O…
531 "status": "A String", # New status for the shipment. Not updated if missing.
532 …"carrier": "A String", # The carrier handling the shipment. Not updated if missing. See shipments[…
533 "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
534 "shipmentId": "A String", # The ID of the shipment.
539 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
540 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
543 …"lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productI…
544 …"productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the …
546 "method": "A String", # The method to apply.
547 "batchId": 42, # An entry ID, unique within the batch request.
549 …the cancelation. Optional. If not set, Google will calculate the default based on the price and ta…
550 "currency": "A String", # The currency of the price.
551 "value": "A String", # The price represented as a number.
554 "currency": "A String", # The currency of the price.
555 "value": "A String", # The price represented as a number.
557 "reasonText": "A String", # The explanation of the reason.
558 …"lineItemId": "A String", # The ID of the line item to cancel. Either lineItemId or productId is r…
559 "reason": "A String", # The reason for the cancellation.
561 "currency": "A String", # The currency of the price.
562 "value": "A String", # The price represented as a number.
564 …"productId": "A String", # The ID of the product to cancel. This is the REST ID used in the produc…
565 "quantity": 42, # The quantity to cancel.
568 "reason": "A String", # The reason for the refund.
570 "currency": "A String", # The currency of the price.
571 "value": "A String", # The price represented as a number.
573 "reasonText": "A String", # The explanation of the reason.
575 "currency": "A String", # The currency of the price.
576 "value": "A String", # The price represented as a number.
578 … "amountPretax": { # The amount that is refunded. Either amount or amountPretax should be filled.
579 "currency": "A String", # The currency of the price.
580 "value": "A String", # The price represented as a number.
584 "reason": "A String", # The reason for the cancellation.
585 "reasonText": "A String", # The explanation of the reason.
588 "reason": "A String", # The reason for the return.
589 "quantity": 42, # The quantity to return.
590 "reasonText": "A String", # The explanation of the reason.
591 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
592 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
594 "merchantId": "A String", # The ID of the managing account.
595 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
602 An object of the form:
605 …rsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
606 "entries": [ # The result of the execution of the batch requests.
608 "batchId": 42, # The ID of the request entry this entry responds to.
609 …tomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "conte…
610 …ors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
611 "message": "A String", # The message of the first error in errors.
612 "code": 42, # The HTTP status of the first error in errors.
614 { # An error returned by the API.
615 "reason": "A String", # The error code.
616 "domain": "A String", # The domain of the error.
617 "message": "A String", # A description of the error.
621 …{ # Order. All methods require the order manager role. # The retrieved order. Only defined if the …
622 "customer": { # The details of the customer who placed the order.
624 "fullName": "A String", # Full name of the customer.
626 …ins the marketing opt-in information that is current at the time that the merchant call. User pref…
629 …ting purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happe…
632 …"promotions": [ # The details of the merchant provided promotions applied to the order. More detai…
636 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
639 "discount": { # The discount in the order price when the promotion is applied.
640 "currency": "A String", # The currency of the price.
641 "value": "A String", # The price represented as a number.
643 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
644 "taxImpact": { # The impact on tax when the promotion is applied.
645 "currency": "A String", # The currency of the price.
646 "value": "A String", # The price represented as a number.
648 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
651 "longTitle": "A String", # The full title of the promotion.
652 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
653 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
654 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
655 …The date and time frame when the promotion is active and ready for validation review. Note that th…
656 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
657 "id": "A String", # The unique ID of the promotion.
660 …"kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "cont…
661 "shippingCostTax": { # The tax for the total shipping cost.
662 "currency": "A String", # The currency of the price.
663 "value": "A String", # The price represented as a number.
665 "shipments": [ # Shipments of the order.
667 "status": "A String", # The status of the shipment.
668 … "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
669 "carrier": "A String", # The carrier handling the shipment.
696 "trackingId": "A String", # The tracking ID for the shipment.
697 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. P…
698 "lineItems": [ # The line items that are shipped.
700 "quantity": 42, # The quantity that is shipped.
701 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
702 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
705 "id": "A String", # The ID of the shipment.
708 "refunds": [ # Refunds for the order.
710 "amount": { # The amount that is refunded.
711 "currency": "A String", # The currency of the price.
712 "value": "A String", # The price represented as a number.
714 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
715 "reason": "A String", # The reason for the refund.
716 "actor": "A String", # The actor that created the refund.
717 "reasonText": "A String", # The explanation of the reason.
720 "paymentMethod": { # The details of the payment method.
721 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
722 "lastFourDigits": "A String", # The last four digits of the card number.
723 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
724 "phoneNumber": "A String", # The billing phone number.
725 "billingAddress": { # The billing address.
728 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
735 "streetAddress": [ # Street-level part of the address.
739 "recipientName": "A String", # Name of the recipient.
740 "isPostOfficeBox": True or False, # Whether the address is a post office box.
741 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
743 "type": "A String", # The type of instrument.
754 "shippingCost": { # The total cost of shipping for all items.
755 "currency": "A String", # The currency of the price.
756 "value": "A String", # The price represented as a number.
758 "acknowledged": True or False, # Whether the order was acknowledged.
759 "paymentStatus": "A String", # The status of the payment.
761 "merchantOrderId": "A String", # Merchant-provided ID of the order.
762 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
764 "status": "A String", # The status of the order.
766 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
767 "address": { # The delivery address
770 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
777 "streetAddress": [ # Street-level part of the address.
781 "recipientName": "A String", # Name of the recipient.
782 "isPostOfficeBox": True or False, # Whether the address is a post office box.
783 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
786 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
790 …"product": { # Product data as seen by customer from the time of the order placement. Note that ce…
791 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
792 … "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
793 … "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
794 "title": "A String", # The title of the product.
795 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
796 …"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, suc…
798 "dimension": "A String", # The dimension of the variant.
799 "value": "A String", # The value for the dimension.
802 "brand": "A String", # Brand of the item.
803 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
804 "offerId": "A String", # An identifier of the item.
805 "price": { # Price of the item.
806 "currency": "A String", # The currency of the price.
807 "value": "A String", # The price represented as a number.
809 "imageLink": "A String", # URL of an image of the item.
810 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
811 "channel": "A String", # The item's channel (online or local).
814 "amount": { # Amount of the fee.
815 "currency": "A String", # The currency of the price.
816 "value": "A String", # The price represented as a number.
818 "name": "A String", # Name of the fee.
821 "id": "A String", # The REST ID of the product.
822 "condition": "A String", # Condition or state of the item.
825 "returnInfo": { # Details of the return policy for the line item.
826 "policyUrl": "A String", # URL of the item return policy.
827 "isReturnable": True or False, # Whether the item is returnable.
828 "daysToReturn": 42, # How many days later the item can be returned.
831 …"price": { # Total price for the line item. For example, if two items for $10 are purchased, the t…
832 "currency": "A String", # The currency of the price.
833 "value": "A String", # The price represented as a number.
836 …tax": { # Total tax amount for the line item. For example, if two items are purchased, and each ha…
837 "currency": "A String", # The currency of the price.
838 "value": "A String", # The price represented as a number.
840 "cancellations": [ # Cancellations of the line item.
842 …n": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory re…
843 … "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
844 "reasonText": "A String", # The explanation of the reason.
845 "actor": "A String", # The actor that created the cancellation.
846 "quantity": 42, # The quantity that was canceled.
850 "annotations": [ # Annotations that are attached to the line item.
852 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
853 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
856 "returns": [ # Returns of the line item.
858 "reason": "A String", # The reason for the return.
859 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
860 "reasonText": "A String", # The explanation of the reason.
861 "actor": "A String", # The actor that created the refund.
867 "id": "A String", # The ID of the line item.
868 "shippingDetails": { # Details of the requested shipping for the line item.
869 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
870 "method": { # Details of the shipping method.
872 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
873 "methodName": "A String", # The name of the shipping method.
876 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
880 …unt": { # The net amount for the order. For example, if an order was originally for a grand total …
881 "currency": "A String", # The currency of the price.
882 "value": "A String", # The price represented as a number.
884 "id": "A String", # The REST ID of the order. Globally unique.
886 "executionStatus": "A String", # The status of the execution. Only defined if
887 # - the request was successful; and
888 # - the method is not get, getByMerchantOrderId, or one of the test methods.
899 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
900 orderId: string, The ID of the order. (required)
903 An object of the form:
905 { # Order. All methods require the order manager role.
906 "customer": { # The details of the customer who placed the order.
908 "fullName": "A String", # Full name of the customer.
910 …ins the marketing opt-in information that is current at the time that the merchant call. User pref…
913 …ting purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happe…
916 …"promotions": [ # The details of the merchant provided promotions applied to the order. More detai…
920 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
923 "discount": { # The discount in the order price when the promotion is applied.
924 "currency": "A String", # The currency of the price.
925 "value": "A String", # The price represented as a number.
927 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
928 "taxImpact": { # The impact on tax when the promotion is applied.
929 "currency": "A String", # The currency of the price.
930 "value": "A String", # The price represented as a number.
932 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
935 "longTitle": "A String", # The full title of the promotion.
936 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
937 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
938 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
939 …The date and time frame when the promotion is active and ready for validation review. Note that th…
940 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
941 "id": "A String", # The unique ID of the promotion.
944 …"kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "cont…
945 "shippingCostTax": { # The tax for the total shipping cost.
946 "currency": "A String", # The currency of the price.
947 "value": "A String", # The price represented as a number.
949 "shipments": [ # Shipments of the order.
951 "status": "A String", # The status of the shipment.
952 … "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
953 "carrier": "A String", # The carrier handling the shipment.
980 "trackingId": "A String", # The tracking ID for the shipment.
981 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. P…
982 "lineItems": [ # The line items that are shipped.
984 "quantity": 42, # The quantity that is shipped.
985 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
986 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
989 "id": "A String", # The ID of the shipment.
992 "refunds": [ # Refunds for the order.
994 "amount": { # The amount that is refunded.
995 "currency": "A String", # The currency of the price.
996 "value": "A String", # The price represented as a number.
998 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
999 "reason": "A String", # The reason for the refund.
1000 "actor": "A String", # The actor that created the refund.
1001 "reasonText": "A String", # The explanation of the reason.
1004 "paymentMethod": { # The details of the payment method.
1005 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
1006 "lastFourDigits": "A String", # The last four digits of the card number.
1007 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
1008 "phoneNumber": "A String", # The billing phone number.
1009 "billingAddress": { # The billing address.
1012 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1019 "streetAddress": [ # Street-level part of the address.
1023 "recipientName": "A String", # Name of the recipient.
1024 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1025 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1027 "type": "A String", # The type of instrument.
1038 "shippingCost": { # The total cost of shipping for all items.
1039 "currency": "A String", # The currency of the price.
1040 "value": "A String", # The price represented as a number.
1042 "acknowledged": True or False, # Whether the order was acknowledged.
1043 "paymentStatus": "A String", # The status of the payment.
1045 "merchantOrderId": "A String", # Merchant-provided ID of the order.
1046 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
1048 "status": "A String", # The status of the order.
1050 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
1051 "address": { # The delivery address
1054 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1061 "streetAddress": [ # Street-level part of the address.
1065 "recipientName": "A String", # Name of the recipient.
1066 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1067 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1070 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
1074 …"product": { # Product data as seen by customer from the time of the order placement. Note that ce…
1075 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
1076 … "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
1077 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
1078 "title": "A String", # The title of the product.
1079 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
1080 …"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, suc…
1082 "dimension": "A String", # The dimension of the variant.
1083 "value": "A String", # The value for the dimension.
1086 "brand": "A String", # Brand of the item.
1087 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
1088 "offerId": "A String", # An identifier of the item.
1089 "price": { # Price of the item.
1090 "currency": "A String", # The currency of the price.
1091 "value": "A String", # The price represented as a number.
1093 "imageLink": "A String", # URL of an image of the item.
1094 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
1095 "channel": "A String", # The item's channel (online or local).
1098 "amount": { # Amount of the fee.
1099 "currency": "A String", # The currency of the price.
1100 "value": "A String", # The price represented as a number.
1102 "name": "A String", # Name of the fee.
1105 "id": "A String", # The REST ID of the product.
1106 "condition": "A String", # Condition or state of the item.
1109 "returnInfo": { # Details of the return policy for the line item.
1110 "policyUrl": "A String", # URL of the item return policy.
1111 "isReturnable": True or False, # Whether the item is returnable.
1112 "daysToReturn": 42, # How many days later the item can be returned.
1115 …"price": { # Total price for the line item. For example, if two items for $10 are purchased, the t…
1116 "currency": "A String", # The currency of the price.
1117 "value": "A String", # The price represented as a number.
1120 …tax": { # Total tax amount for the line item. For example, if two items are purchased, and each ha…
1121 "currency": "A String", # The currency of the price.
1122 "value": "A String", # The price represented as a number.
1124 "cancellations": [ # Cancellations of the line item.
1126 …n": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory re…
1127 … "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
1128 "reasonText": "A String", # The explanation of the reason.
1129 "actor": "A String", # The actor that created the cancellation.
1130 "quantity": 42, # The quantity that was canceled.
1134 "annotations": [ # Annotations that are attached to the line item.
1136 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
1137 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
1140 "returns": [ # Returns of the line item.
1142 "reason": "A String", # The reason for the return.
1143 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1144 "reasonText": "A String", # The explanation of the reason.
1145 "actor": "A String", # The actor that created the refund.
1151 "id": "A String", # The ID of the line item.
1152 "shippingDetails": { # Details of the requested shipping for the line item.
1153 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
1154 "method": { # Details of the shipping method.
1156 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
1157 "methodName": "A String", # The name of the shipping method.
1160 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
1164 …unt": { # The net amount for the order. For example, if an order was originally for a grand total …
1165 "currency": "A String", # The currency of the price.
1166 "value": "A String", # The price represented as a number.
1168 "id": "A String", # The REST ID of the order. Globally unique.
1177 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
1178 merchantOrderId: string, The merchant order ID to be looked for. (required)
1181 An object of the form:
1184 …rchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
1185 "order": { # Order. All methods require the order manager role. # The requested order.
1186 "customer": { # The details of the customer who placed the order.
1188 "fullName": "A String", # Full name of the customer.
1190 …ins the marketing opt-in information that is current at the time that the merchant call. User pref…
1193 …ting purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happe…
1196 …"promotions": [ # The details of the merchant provided promotions applied to the order. More detai…
1200 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
1203 "discount": { # The discount in the order price when the promotion is applied.
1204 "currency": "A String", # The currency of the price.
1205 "value": "A String", # The price represented as a number.
1207 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
1208 "taxImpact": { # The impact on tax when the promotion is applied.
1209 "currency": "A String", # The currency of the price.
1210 "value": "A String", # The price represented as a number.
1212 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
1215 "longTitle": "A String", # The full title of the promotion.
1216 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
1217 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
1218 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
1219 …The date and time frame when the promotion is active and ready for validation review. Note that th…
1220 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
1221 "id": "A String", # The unique ID of the promotion.
1224 …"kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "cont…
1225 "shippingCostTax": { # The tax for the total shipping cost.
1226 "currency": "A String", # The currency of the price.
1227 "value": "A String", # The price represented as a number.
1229 "shipments": [ # Shipments of the order.
1231 "status": "A String", # The status of the shipment.
1232 … "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
1233 "carrier": "A String", # The carrier handling the shipment.
1260 "trackingId": "A String", # The tracking ID for the shipment.
1261 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. P…
1262 "lineItems": [ # The line items that are shipped.
1264 "quantity": 42, # The quantity that is shipped.
1265 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
1266 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
1269 "id": "A String", # The ID of the shipment.
1272 "refunds": [ # Refunds for the order.
1274 "amount": { # The amount that is refunded.
1275 "currency": "A String", # The currency of the price.
1276 "value": "A String", # The price represented as a number.
1278 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1279 "reason": "A String", # The reason for the refund.
1280 "actor": "A String", # The actor that created the refund.
1281 "reasonText": "A String", # The explanation of the reason.
1284 "paymentMethod": { # The details of the payment method.
1285 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
1286 "lastFourDigits": "A String", # The last four digits of the card number.
1287 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
1288 "phoneNumber": "A String", # The billing phone number.
1289 "billingAddress": { # The billing address.
1292 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1299 "streetAddress": [ # Street-level part of the address.
1303 "recipientName": "A String", # Name of the recipient.
1304 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1305 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1307 "type": "A String", # The type of instrument.
1318 "shippingCost": { # The total cost of shipping for all items.
1319 "currency": "A String", # The currency of the price.
1320 "value": "A String", # The price represented as a number.
1322 "acknowledged": True or False, # Whether the order was acknowledged.
1323 "paymentStatus": "A String", # The status of the payment.
1325 "merchantOrderId": "A String", # Merchant-provided ID of the order.
1326 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
1328 "status": "A String", # The status of the order.
1330 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
1331 "address": { # The delivery address
1334 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1341 "streetAddress": [ # Street-level part of the address.
1345 "recipientName": "A String", # Name of the recipient.
1346 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1347 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1350 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
1354 …"product": { # Product data as seen by customer from the time of the order placement. Note that ce…
1355 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
1356 … "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
1357 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
1358 "title": "A String", # The title of the product.
1359 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
1360 …"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, suc…
1362 "dimension": "A String", # The dimension of the variant.
1363 "value": "A String", # The value for the dimension.
1366 "brand": "A String", # Brand of the item.
1367 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
1368 "offerId": "A String", # An identifier of the item.
1369 "price": { # Price of the item.
1370 "currency": "A String", # The currency of the price.
1371 "value": "A String", # The price represented as a number.
1373 "imageLink": "A String", # URL of an image of the item.
1374 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
1375 "channel": "A String", # The item's channel (online or local).
1378 "amount": { # Amount of the fee.
1379 "currency": "A String", # The currency of the price.
1380 "value": "A String", # The price represented as a number.
1382 "name": "A String", # Name of the fee.
1385 "id": "A String", # The REST ID of the product.
1386 "condition": "A String", # Condition or state of the item.
1389 "returnInfo": { # Details of the return policy for the line item.
1390 "policyUrl": "A String", # URL of the item return policy.
1391 "isReturnable": True or False, # Whether the item is returnable.
1392 "daysToReturn": 42, # How many days later the item can be returned.
1395 …"price": { # Total price for the line item. For example, if two items for $10 are purchased, the t…
1396 "currency": "A String", # The currency of the price.
1397 "value": "A String", # The price represented as a number.
1400 …tax": { # Total tax amount for the line item. For example, if two items are purchased, and each ha…
1401 "currency": "A String", # The currency of the price.
1402 "value": "A String", # The price represented as a number.
1404 "cancellations": [ # Cancellations of the line item.
1406 …n": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory re…
1407 … "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
1408 "reasonText": "A String", # The explanation of the reason.
1409 "actor": "A String", # The actor that created the cancellation.
1410 "quantity": 42, # The quantity that was canceled.
1414 "annotations": [ # Annotations that are attached to the line item.
1416 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
1417 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
1420 "returns": [ # Returns of the line item.
1422 "reason": "A String", # The reason for the return.
1423 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1424 "reasonText": "A String", # The explanation of the reason.
1425 "actor": "A String", # The actor that created the refund.
1431 "id": "A String", # The ID of the line item.
1432 "shippingDetails": { # Details of the requested shipping for the line item.
1433 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
1434 "method": { # Details of the shipping method.
1436 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
1437 "methodName": "A String", # The name of the shipping method.
1440 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
1444 …unt": { # The net amount for the order. For example, if an order was originally for a grand total …
1445 "currency": "A String", # The currency of the price.
1446 "value": "A String", # The price represented as a number.
1448 "id": "A String", # The REST ID of the order. Globally unique.
1458 …merchantId: string, The ID of the account that should manage the order. This cannot be a multi-cli…
1459 templateName: string, The name of the template to retrieve. (required)
1465 country: string, The country of the template to retrieve. Defaults to US.
1468 An object of the form:
1471 …OrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
1472 "template": { # The requested test order template.
1473 "customer": { # The details of the customer who placed the order.
1475 "fullName": "A String", # Full name of the customer.
1476 "email": "A String", # Email address of the customer.
1486 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
1489 "discount": { # The discount in the order price when the promotion is applied.
1490 "currency": "A String", # The currency of the price.
1491 "value": "A String", # The price represented as a number.
1493 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
1494 "taxImpact": { # The impact on tax when the promotion is applied.
1495 "currency": "A String", # The currency of the price.
1496 "value": "A String", # The price represented as a number.
1498 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
1501 "longTitle": "A String", # The full title of the promotion.
1502 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
1503 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
1504 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
1505 …The date and time frame when the promotion is active and ready for validation review. Note that th…
1506 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
1507 "id": "A String", # The unique ID of the promotion.
1510 …"kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "…
1512 "currency": "A String", # The currency of the price.
1513 "value": "A String", # The price represented as a number.
1516 …nedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the …
1517 …"shippingCost": { # The price of shipping for all items. Shipping tax is automatically calculated …
1518 "currency": "A String", # The currency of the price.
1519 "value": "A String", # The price represented as a number.
1521 "shippingOption": "A String", # The requested shipping option.
1522 …"enableOrderinvoices": True or False, # Whether the orderinvoices service should support this orde…
1525 "returnInfo": { # Details of the return policy for the line item.
1526 "policyUrl": "A String", # URL of the item return policy.
1527 "isReturnable": True or False, # Whether the item is returnable.
1528 "daysToReturn": 42, # How many days later the item can be returned.
1530 "product": { # Product data from the time of the order placement.
1531 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
1532 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
1533 "title": "A String", # The title of the product.
1534 "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
1535 "variantAttributes": [ # Variant attributes for the item. Optional.
1537 "dimension": "A String", # The dimension of the variant.
1538 "value": "A String", # The value for the dimension.
1541 "brand": "A String", # Brand of the item.
1542 … "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
1543 "offerId": "A String", # An identifier of the item.
1544 "imageLink": "A String", # URL of an image of the item.
1545 "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
1547 "fees": [ # Fees for the item. Optional.
1549 "amount": { # Amount of the fee.
1550 "currency": "A String", # The currency of the price.
1551 "value": "A String", # The price represented as a number.
1553 "name": "A String", # Name of the fee.
1556 …"price": { # The price for the product. Tax is automatically calculated for MFL orders. For non-MF…
1557 "currency": "A String", # The currency of the price.
1558 "value": "A String", # The price represented as a number.
1560 "condition": "A String", # Condition or state of the item.
1563 "currency": "A String", # The currency of the price.
1564 "value": "A String", # The price represented as a number.
1567 "shippingDetails": { # Details of the requested shipping for the line item.
1568 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
1569 "method": { # Details of the shipping method.
1571 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
1572 "methodName": "A String", # The name of the shipping method.
1575 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
1579 "paymentMethod": { # The details of the payment method.
1580 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
1581 …"type": "A String", # The type of instrument. Note that real orders might have different values th…
1582 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
1583 "lastFourDigits": "A String", # The last four digits of the card number.
1584 "predefinedBillingAddress": "A String", # The billing address.
1593 …the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to t…
1596 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
1597 orderId: string, The ID of the order. (required)
1598 body: object, The request body. (required)
1599 The object takes the form of:
1602 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
1603 "reason": "A String", # The reason for the return.
1604 "amountPretax": { # The amount that is refunded. Required.
1605 "currency": "A String", # The currency of the price.
1606 "value": "A String", # The price represented as a number.
1608 "reasonText": "A String", # The explanation of the reason.
1609 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
1611 "currency": "A String", # The currency of the price.
1612 "value": "A String", # The price represented as a number.
1614 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
1615 "quantity": 42, # The quantity to return and refund.
1620 An object of the form:
1623 …efundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
1624 "executionStatus": "A String", # The status of the execution.
1630 <pre>Lists the orders in your Merchant Center account.
1633 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
1639 pageToken: string, The token returned by the previous request.
1641 …acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obt…
1642 We recommend using this filter set to false, in conjunction with the acknowledge call, such that on…
1643 …sults: integer, The maximum number of orders to return in the response, used for paging. The defau…
1645 …statuses: string, Obtains orders that match any of the specified statuses. Multiple values can be …
1660 An object of the form:
1663 "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
1664 …"kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed…
1666 { # Order. All methods require the order manager role.
1667 "customer": { # The details of the customer who placed the order.
1669 "fullName": "A String", # Full name of the customer.
1671 …ins the marketing opt-in information that is current at the time that the merchant call. User pref…
1674 …ting purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happe…
1677 …"promotions": [ # The details of the merchant provided promotions applied to the order. More detai…
1681 …"offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit …
1684 "discount": { # The discount in the order price when the promotion is applied.
1685 "currency": "A String", # The currency of the price.
1686 "value": "A String", # The price represented as a number.
1688 …"type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shi…
1689 "taxImpact": { # The impact on tax when the promotion is applied.
1690 "currency": "A String", # The currency of the price.
1691 "value": "A String", # The price represented as a number.
1693 …"subType": "A String", # Further describes the benefit of the promotion. Note that we will expand …
1696 "longTitle": "A String", # The full title of the promotion.
1697 …icRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when ap…
1698 "redemptionChannel": "A String", # Indicates that the promotion is valid online.
1699 …"productApplicability": "A String", # Whether the promotion is applicable to all products or only …
1700 …The date and time frame when the promotion is active and ready for validation review. Note that th…
1701 …The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of th…
1702 "id": "A String", # The unique ID of the promotion.
1705 …"kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "cont…
1706 "shippingCostTax": { # The tax for the total shipping cost.
1707 "currency": "A String", # The currency of the price.
1708 "value": "A String", # The price represented as a number.
1710 "shipments": [ # Shipments of the order.
1712 "status": "A String", # The status of the shipment.
1713 … "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
1714 "carrier": "A String", # The carrier handling the shipment.
1741 "trackingId": "A String", # The tracking ID for the shipment.
1742 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. P…
1743 "lineItems": [ # The line items that are shipped.
1745 "quantity": 42, # The quantity that is shipped.
1746 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
1747 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
1750 "id": "A String", # The ID of the shipment.
1753 "refunds": [ # Refunds for the order.
1755 "amount": { # The amount that is refunded.
1756 "currency": "A String", # The currency of the price.
1757 "value": "A String", # The price represented as a number.
1759 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1760 "reason": "A String", # The reason for the refund.
1761 "actor": "A String", # The actor that created the refund.
1762 "reasonText": "A String", # The explanation of the reason.
1765 "paymentMethod": { # The details of the payment method.
1766 "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
1767 "lastFourDigits": "A String", # The last four digits of the card number.
1768 "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
1769 "phoneNumber": "A String", # The billing phone number.
1770 "billingAddress": { # The billing address.
1773 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1780 "streetAddress": [ # Street-level part of the address.
1784 "recipientName": "A String", # Name of the recipient.
1785 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1786 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1788 "type": "A String", # The type of instrument.
1799 "shippingCost": { # The total cost of shipping for all items.
1800 "currency": "A String", # The currency of the price.
1801 "value": "A String", # The price represented as a number.
1803 "acknowledged": True or False, # Whether the order was acknowledged.
1804 "paymentStatus": "A String", # The status of the payment.
1806 "merchantOrderId": "A String", # Merchant-provided ID of the order.
1807 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
1809 "status": "A String", # The status of the order.
1811 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
1812 "address": { # The delivery address
1815 …"fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for …
1822 "streetAddress": [ # Street-level part of the address.
1826 "recipientName": "A String", # Name of the recipient.
1827 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1828 …"region": "A String", # Top-level administrative subdivision of the country. For example, a state …
1831 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
1835 …"product": { # Product data as seen by customer from the time of the order placement. Note that ce…
1836 … "targetCountry": "A String", # The CLDR territory code of the target country of the product.
1837 … "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
1838 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
1839 "title": "A String", # The title of the product.
1840 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
1841 …"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, suc…
1843 "dimension": "A String", # The dimension of the variant.
1844 "value": "A String", # The value for the dimension.
1847 "brand": "A String", # Brand of the item.
1848 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
1849 "offerId": "A String", # An identifier of the item.
1850 "price": { # Price of the item.
1851 "currency": "A String", # The currency of the price.
1852 "value": "A String", # The price represented as a number.
1854 "imageLink": "A String", # URL of an image of the item.
1855 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
1856 "channel": "A String", # The item's channel (online or local).
1859 "amount": { # Amount of the fee.
1860 "currency": "A String", # The currency of the price.
1861 "value": "A String", # The price represented as a number.
1863 "name": "A String", # Name of the fee.
1866 "id": "A String", # The REST ID of the product.
1867 "condition": "A String", # Condition or state of the item.
1870 "returnInfo": { # Details of the return policy for the line item.
1871 "policyUrl": "A String", # URL of the item return policy.
1872 "isReturnable": True or False, # Whether the item is returnable.
1873 "daysToReturn": 42, # How many days later the item can be returned.
1876 …"price": { # Total price for the line item. For example, if two items for $10 are purchased, the t…
1877 "currency": "A String", # The currency of the price.
1878 "value": "A String", # The price represented as a number.
1881 …tax": { # Total tax amount for the line item. For example, if two items are purchased, and each ha…
1882 "currency": "A String", # The currency of the price.
1883 "value": "A String", # The price represented as a number.
1885 "cancellations": [ # Cancellations of the line item.
1887 …n": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory re…
1888 … "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
1889 "reasonText": "A String", # The explanation of the reason.
1890 "actor": "A String", # The actor that created the cancellation.
1891 "quantity": 42, # The quantity that was canceled.
1895 "annotations": [ # Annotations that are attached to the line item.
1897 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
1898 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
1901 "returns": [ # Returns of the line item.
1903 "reason": "A String", # The reason for the return.
1904 … "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1905 "reasonText": "A String", # The explanation of the reason.
1906 "actor": "A String", # The actor that created the refund.
1912 "id": "A String", # The ID of the line item.
1913 "shippingDetails": { # Details of the requested shipping for the line item.
1914 "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
1915 "method": { # Details of the shipping method.
1917 …"carrier": "A String", # The carrier for the shipping. Optional. See shipments[].carrier for a lis…
1918 "methodName": "A String", # The name of the shipping method.
1921 "shipByDate": "A String", # The ship by date, in ISO 8601 format.
1925 …unt": { # The net amount for the order. For example, if an order was originally for a grand total …
1926 "currency": "A String", # The currency of the price.
1927 "value": "A String", # The price represented as a number.
1929 "id": "A String", # The REST ID of the order. Globally unique.
1937 <pre>Retrieves the next page of results.
1940 previous_request: The request for the previous page. (required)
1941 previous_response: The response from the request for the previous page. (required)
1944 A request object that you can call 'execute()' on to request the next
1945 page. Returns None if there are no more items in the collection.
1954 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
1955 orderId: string, The ID of the order to refund. (required)
1956 body: object, The request body. (required)
1957 The object takes the form of:
1960 "amountPretax": { # The amount that is refunded. Either amount or amountPretax should be filled.
1961 "currency": "A String", # The currency of the price.
1962 "value": "A String", # The price represented as a number.
1965 "currency": "A String", # The currency of the price.
1966 "value": "A String", # The price represented as a number.
1968 "reason": "A String", # The reason for the refund.
1969 "reasonText": "A String", # The explanation of the reason.
1971 "currency": "A String", # The currency of the price.
1972 "value": "A String", # The price represented as a number.
1974 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
1979 An object of the form:
1982 …"kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fix…
1983 "executionStatus": "A String", # The status of the execution.
1992 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
1993 orderId: string, The ID of the order. (required)
1994 body: object, The request body. (required)
1995 The object takes the form of:
1998 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
1999 "reason": "A String", # The reason for the return.
2000 "reasonText": "A String", # The explanation of the reason.
2001 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
2002 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
2003 "quantity": 42, # The quantity to return and refund.
2008 An object of the form:
2011 …eturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2012 "executionStatus": "A String", # The status of the execution.
2021 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2022 orderId: string, The ID of the order. (required)
2023 body: object, The request body. (required)
2024 The object takes the form of:
2027 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2028 "reason": "A String", # The reason for the return.
2029 "reasonText": "A String", # The explanation of the reason.
2030 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
2031 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
2032 "quantity": 42, # The quantity to return.
2037 An object of the form:
2040 …eturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2041 "executionStatus": "A String", # The status of the execution.
2050 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2051 orderId: string, The ID of the order. (required)
2052 body: object, The request body. (required)
2053 The object takes the form of:
2056 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2057 "reason": "A String", # The reason for the return.
2058 …"amountPretax": { # The amount that is refunded. If omitted, refundless return is assumed (same as…
2059 "currency": "A String", # The currency of the price.
2060 "value": "A String", # The price represented as a number.
2062 "reasonText": "A String", # The explanation of the reason.
2063 …"lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is r…
2065 "currency": "A String", # The currency of the price.
2066 "value": "A String", # The price represented as a number.
2068 …"productId": "A String", # The ID of the product to return. This is the REST ID used in the produc…
2069 "quantity": 42, # The quantity to return and refund.
2074 An object of the form:
2077 …efundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2078 "executionStatus": "A String", # The status of the execution.
2084 …the form of key-value pairs. A common use case would be to supply us with additional structured in…
2087 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2088 orderId: string, The ID of the order. (required)
2089 body: object, The request body. (required)
2090 The object takes the form of:
2093 …"productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the …
2096 …ing", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
2097 …tring", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
2100 …"lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productI…
2101 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2106 An object of the form:
2109 …eItemMetadataResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2110 "executionStatus": "A String", # The status of the execution.
2119 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2120 orderId: string, The ID of the order. (required)
2121 body: object, The request body. (required)
2122 The object takes the form of:
2125 …"shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderi…
2128 …"carrier": "A String", # The carrier handling the shipment. See shipments[].carrier in the Orders…
2129 "trackingId": "A String", # The tracking ID for the shipment.
2130 …"shipmentId": "A String", # The ID of the shipment. This is assigned by the merchant and is unique…
2133 …eprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].car…
2134 …ngId": "A String", # Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.
2135 "shipmentId": "A String", # Deprecated. Please use shipmentInfo instead. The ID of the shipment.
2138 "quantity": 42, # The quantity that is shipped.
2139 …"lineItemId": "A String", # The ID of the line item that is shipped. Either lineItemId or productI…
2140 …"productId": "A String", # The ID of the product to ship. This is the REST ID used in the products…
2143 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2148 An object of the form:
2151 …ShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2152 "executionStatus": "A String", # The status of the execution.
2161 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2162 orderId: string, The ID of the order. (required)
2163 body: object, The request body. (required)
2164 The object takes the form of:
2169 # Provided date should be within 1 year timeframe and can not be a date in the past.
2172 # Provided date should be within 1 year timeframe and can not be a date in the past.
2173 …"productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the …
2174 …"lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productI…
2175 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2180 An object of the form:
2183 …ippingDetailsResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2184 "executionStatus": "A String", # The status of the execution.
2190 <pre>Updates the merchant order ID for a given order.
2193 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2194 orderId: string, The ID of the order. (required)
2195 body: object, The request body. (required)
2196 The object takes the form of:
2199 …"merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique…
2200 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2205 An object of the form:
2208 …rchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2209 "executionStatus": "A String", # The status of the execution.
2218 …merchantId: string, The ID of the account that manages the order. This cannot be a multi-client ac…
2219 orderId: string, The ID of the order. (required)
2220 body: object, The request body. (required)
2221 The object takes the form of:
2224 "status": "A String", # New status for the shipment. Not updated if missing.
2225 …"carrier": "A String", # The carrier handling the shipment. Not updated if missing. See shipments[…
2226 "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
2227 "shipmentId": "A String", # The ID of the shipment.
2228 …"deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. O…
2229 …"operationId": "A String", # The ID of the operation. Unique across all operations for a given ord…
2234 An object of the form:
2237 …pdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "conte…
2238 "executionStatus": "A String", # The status of the execution.