Class: Google::Apis::ContentV2sandbox::ShoppingContentService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/content_v2sandbox/service.rb

Overview

Content API for Shopping

Manages product items, inventory, and Merchant Center accounts for Google Shopping.

Examples:

require 'google/apis/content_v2sandbox'

Content = Google::Apis::ContentV2sandbox # Alias the module
service = Content::ShoppingContentService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ ShoppingContentService

Returns a new instance of ShoppingContentService



50
51
52
53
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 50

def initialize
  super('https://www.googleapis.com/', 'content/v2sandbox/')
  @batch_path = 'batch/content/v2sandbox'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



48
49
50
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

#acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse

Marks an order as acknowledged.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_acknowledge_request_object (Google::Apis::ContentV2sandbox::OrdersAcknowledgeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 323

def acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/acknowledge', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersAcknowledgeRequest::Representation
  command.request_object = orders_acknowledge_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse

Sandbox only. Moves a test order from state "inProgress" to state " pendingShipment".

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the test order to modify.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



363
364
365
366
367
368
369
370
371
372
373
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 363

def advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/testorders/{orderId}/advance', options)
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersCancelResponse

Cancels all line items in an order, making a full refund.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order to cancel.

  • orders_cancel_request_object (Google::Apis::ContentV2sandbox::OrdersCancelRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 401

def cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/cancel', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersCancelRequest::Representation
  command.request_object = orders_cancel_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersCancelResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersCancelResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse

Cancels a line item, making a full refund.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_cancel_line_item_request_object (Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 441

def cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/cancelLineItem', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest::Representation
  command.request_object = orders_cancel_line_item_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse

Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orderinvoices_create_charge_invoice_request_object (Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 82

def createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createChargeInvoice', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceRequest::Representation
  command.request_object = orderinvoices_create_charge_invoice_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse

Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orderinvoices_create_refund_invoice_request_object (Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 123

def createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createRefundInvoice', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceRequest::Representation
  command.request_object = orderinvoices_create_refund_invoice_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse

Sandbox only. Creates a test order.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that should manage the order. This cannot be a multi- client account.

  • orders_create_test_order_request_object (Google::Apis::ContentV2sandbox::OrdersCreateTestOrderRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 479

def createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/testorders', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderRequest::Representation
  command.request_object = orders_create_test_order_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_order(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse

Retrieves or modifies multiple orders in a single request.

Parameters:

  • orders_custom_batch_request_object (Google::Apis::ContentV2sandbox::OrdersCustomBatchRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



513
514
515
516
517
518
519
520
521
522
523
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 513

def custombatch_order(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'orders/batch', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersCustomBatchRequest::Representation
  command.request_object = orders_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::Order

Retrieves an order from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



550
551
552
553
554
555
556
557
558
559
560
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 550

def get_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{merchantId}/orders/{orderId}', options)
  command.response_representation = Google::Apis::ContentV2sandbox::Order::Representation
  command.response_class = Google::Apis::ContentV2sandbox::Order
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse

Retrieves an order using merchant order id.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • merchant_order_id (String) —

    The merchant order id to be looked for.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



587
588
589
590
591
592
593
594
595
596
597
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 587

def getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{merchantId}/ordersbymerchantid/{merchantOrderId}', options)
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['merchantOrderId'] = merchant_order_id unless merchant_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#gettestordertemplate_order(merchant_id, template_name, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that should manage the order. This cannot be a multi- client account.

  • template_name (String) —

    The name of the template to retrieve.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



625
626
627
628
629
630
631
632
633
634
635
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 625

def gettestordertemplate_order(merchant_id, template_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{merchantId}/testordertemplates/{templateName}', options)
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['templateName'] = template_name unless template_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse

Notifies that item return and refund was handled directly in store.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_in_store_refund_line_item_request_object (Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 663

def instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/inStoreRefundLineItem', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemRequest::Representation
  command.request_object = orders_in_store_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersListResponse

Lists the orders in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • 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.

  • max_results (Fixnum) —

    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. Known issue: All List calls will return all Orders without limit regardless of the value of this field.

  • order_by (String) —

    The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.

  • page_token (String) —

    The token returned by the previous request.

  • placed_date_end (String) —

    Obtains orders placed before this date (exclusively), in ISO 8601 format.

  • placed_date_start (String) —

    Obtains orders placed after this date (inclusively), in ISO 8601 format.

  • statuses (Array<String>, String) —

    Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 731

def list_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{merchantId}/orders', options)
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersListResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['acknowledged'] = acknowledged unless acknowledged.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['placedDateEnd'] = placed_date_end unless placed_date_end.nil?
  command.query['placedDateStart'] = placed_date_start unless placed_date_start.nil?
  command.query['statuses'] = statuses unless statuses.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#notifyauthapproved_orderpayment(merchant_id, order_id, orderpayments_notify_auth_approved_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse

Notify about successfully authorizing user's payment method for a given amount.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order for for which payment authorization is happening.

  • orderpayments_notify_auth_approved_request_object (Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 163

def notifyauthapproved_orderpayment(merchant_id, order_id, orderpayments_notify_auth_approved_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthApproved', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedRequest::Representation
  command.request_object = orderpayments_notify_auth_approved_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#notifyauthdeclined_orderpayment(merchant_id, order_id, orderpayments_notify_auth_declined_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse

Notify about failure to authorize user's payment method.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order for which payment authorization was declined.

  • orderpayments_notify_auth_declined_request_object (Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 203

def notifyauthdeclined_orderpayment(merchant_id, order_id, orderpayments_notify_auth_declined_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthDeclined', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedRequest::Representation
  command.request_object = orderpayments_notify_auth_declined_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#notifycharge_orderpayment(merchant_id, order_id, orderpayments_notify_charge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse

Notify about charge on user's selected payments method.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order for which charge is happening.

  • orderpayments_notify_charge_request_object (Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 243

def notifycharge_orderpayment(merchant_id, order_id, orderpayments_notify_charge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyCharge', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeRequest::Representation
  command.request_object = orderpayments_notify_charge_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#notifyrefund_orderpayment(merchant_id, order_id, orderpayments_notify_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse

Notify about refund on user's selected payments method.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order for which charge is happening.

  • orderpayments_notify_refund_request_object (Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 283

def notifyrefund_orderpayment(merchant_id, order_id, orderpayments_notify_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyRefund', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundRequest::Representation
  command.request_object = orderpayments_notify_refund_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#refund_order(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersRefundResponse

Refund a portion of the order, up to the full amount paid.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order to refund.

  • orders_refund_request_object (Google::Apis::ContentV2sandbox::OrdersRefundRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 775

def refund_order(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/refund', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersRefundRequest::Representation
  command.request_object = orders_refund_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersRefundResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersRefundResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse

Rejects return on an line item.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_reject_return_line_item_request_object (Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 815

def rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/rejectReturnLineItem', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemRequest::Representation
  command.request_object = orders_reject_return_line_item_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#returnlineitem_order(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse

Returns a line item.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_return_line_item_request_object (Google::Apis::ContentV2sandbox::OrdersReturnLineItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 855

def returnlineitem_order(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/returnLineItem', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersReturnLineItemRequest::Representation
  command.request_object = orders_return_line_item_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse

Returns and refunds a line item. Note that this method can only be called on fully shipped orders.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_return_refund_line_item_request_object (Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 896

def returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/returnRefundLineItem', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemRequest::Representation
  command.request_object = orders_return_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#setlineitemmetadata_order(merchant_id, order_id, orders_set_line_item_metadata_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse

Sets (overrides) merchant provided annotations on the line item.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_set_line_item_metadata_request_object (Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 936

def setlineitemmetadata_order(merchant_id, order_id, orders_set_line_item_metadata_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/setLineItemMetadata', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataRequest::Representation
  command.request_object = orders_set_line_item_metadata_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse

Marks line item(s) as shipped.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_ship_line_items_request_object (Google::Apis::ContentV2sandbox::OrdersShipLineItemsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 976

def shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/shipLineItems', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersShipLineItemsRequest::Representation
  command.request_object = orders_ship_line_items_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse

Updates ship by and delivery by dates for a line item.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_update_line_item_shipping_details_request_object (Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 1016

def updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/updateLineItemShippingDetails', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsRequest::Representation
  command.request_object = orders_update_line_item_shipping_details_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#updatemerchantorderid_order(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse

Updates the merchant order ID for a given order.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_update_merchant_order_id_request_object (Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 1056

def updatemerchantorderid_order(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/updateMerchantOrderId', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdRequest::Representation
  command.request_object = orders_update_merchant_order_id_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#updateshipment_order(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse

Updates a shipment's status, carrier, and/or tracking ID.

Parameters:

  • merchant_id (Fixnum) —

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String) —

    The ID of the order.

  • orders_update_shipment_request_object (Google::Apis::ContentV2sandbox::OrdersUpdateShipmentRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'generated/google/apis/content_v2sandbox/service.rb', line 1096

def updateshipment_order(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orders/{orderId}/updateShipment', options)
  command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentRequest::Representation
  command.request_object = orders_update_shipment_request_object
  command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse::Representation
  command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end