Content API for Shopping: orders. Manages product items, inventory, and Merchant Center accounts for Google Shopping. See: https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders
Content API for Shopping: orders. Manages product items, inventory, and Merchant Center accounts for Google Shopping. See: https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders
(acknowledge$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/acknowledge
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:operationId string}
Marks an order as acknowledged.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/acknowledge Required parameters: merchantId, orderId Optional parameters: none Body: {:operationId string} Marks an order as acknowledged.
(advancetestorder$ auth args)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/advancetestorder
Required parameters: merchantId, orderId
Optional parameters: none Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/advancetestorder Required parameters: merchantId, orderId Optional parameters: none Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
(cancel$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/cancel
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:operationId string, :reason string, :reasonText string}
Cancels all line items in an order, making a full refund.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/cancel Required parameters: merchantId, orderId Optional parameters: none Body: {:operationId string, :reason string, :reasonText string} Cancels all line items in an order, making a full refund.
(cancellineitem$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/cancellineitem
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:lineItemId string, :operationId string, :productId string, :quantity integer, :reason string, :reasonText string}
Cancels a line item, making a full refund.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/cancellineitem Required parameters: merchantId, orderId Optional parameters: none Body: {:lineItemId string, :operationId string, :productId string, :quantity integer, :reason string, :reasonText string} Cancels a line item, making a full refund.
(canceltestorderbycustomer$ auth args body)
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:reason string}
Sandbox only. Cancels a test order for customer-initiated cancellation.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/canceltestorderbycustomer Required parameters: merchantId, orderId Optional parameters: none Body: {:reason string} Sandbox only. Cancels a test order for customer-initiated cancellation.
(createtestorder$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/createtestorder
Required parameters: merchantId
Optional parameters: none
Body:
{:country string, :templateName string, :testOrder {:promotions [OrderPromotion], :predefinedPickupDetails string, :shippingOption string, :enableOrderinvoices boolean, :predefinedBillingAddress string, :lineItems [TestOrderLineItem], :shippingCost Price, :kind string, :predefinedDeliveryAddress string, :predefinedEmail string, :notificationMode string}}
Sandbox only. Creates a test order.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/createtestorder Required parameters: merchantId Optional parameters: none Body: {:country string, :templateName string, :testOrder {:promotions [OrderPromotion], :predefinedPickupDetails string, :shippingOption string, :enableOrderinvoices boolean, :predefinedBillingAddress string, :lineItems [TestOrderLineItem], :shippingCost Price, :kind string, :predefinedDeliveryAddress string, :predefinedEmail string, :notificationMode string}} Sandbox only. Creates a test order.
(createtestreturn$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/createtestreturn
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:items [{:lineItemId string, :quantity integer}]}
Sandbox only. Creates a test return.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/createtestreturn Required parameters: merchantId, orderId Optional parameters: none Body: {:items [{:lineItemId string, :quantity integer}]} Sandbox only. Creates a test return.
(get$ auth args)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/get
Required parameters: merchantId, orderId
Optional parameters: none Retrieves an order from your Merchant Center account.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/get Required parameters: merchantId, orderId Optional parameters: none Retrieves an order from your Merchant Center account.
(getbymerchantorderid$ auth args)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/getbymerchantorderid
Required parameters: merchantId, merchantOrderId
Optional parameters: none Retrieves an order using merchant order ID.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/getbymerchantorderid Required parameters: merchantId, merchantOrderId Optional parameters: none Retrieves an order using merchant order ID.
(gettestordertemplate$ auth args)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/gettestordertemplate
Required parameters: merchantId, templateName
Optional parameters: country Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/gettestordertemplate Required parameters: merchantId, templateName Optional parameters: country Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
(instorerefundlineitem$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/instorerefundlineitem
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:lineItemId string, :operationId string, :priceAmount {:currency string, :value string}, :productId string, :quantity integer, :reason string, :reasonText string, :taxAmount {:currency string, :value string}}
Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/instorerefundlineitem Required parameters: merchantId, orderId Optional parameters: none Body: {:lineItemId string, :operationId string, :priceAmount {:currency string, :value string}, :productId string, :quantity integer, :reason string, :reasonText string, :taxAmount {:currency string, :value string}} Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.
(list$ auth args)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/list
Required parameters: merchantId
Optional parameters: acknowledged, maxResults, orderBy, pageToken, placedDateEnd, placedDateStart, statuses Lists the orders in your Merchant Center account.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/list Required parameters: merchantId Optional parameters: acknowledged, maxResults, orderBy, pageToken, placedDateEnd, placedDateStart, statuses Lists the orders in your Merchant Center account.
(rejectreturnlineitem$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/rejectreturnlineitem
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:lineItemId string, :operationId string, :productId string, :quantity integer, :reason string, :reasonText string}
Rejects return on an line item.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/rejectreturnlineitem Required parameters: merchantId, orderId Optional parameters: none Body: {:lineItemId string, :operationId string, :productId string, :quantity integer, :reason string, :reasonText string} Rejects return on an line item.
(returnrefundlineitem$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/returnrefundlineitem
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:lineItemId string, :operationId string, :priceAmount {:currency string, :value string}, :productId string, :quantity integer, :reason string, :reasonText string, :taxAmount {:currency string, :value string}}
Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/returnrefundlineitem Required parameters: merchantId, orderId Optional parameters: none Body: {:lineItemId string, :operationId string, :priceAmount {:currency string, :value string}, :productId string, :quantity integer, :reason string, :reasonText string, :taxAmount {:currency string, :value string}} Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
(setlineitemmetadata$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/setlineitemmetadata
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:annotations [{:key string, :value string}], :lineItemId string, :operationId string, :productId string}
Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/setlineitemmetadata Required parameters: merchantId, orderId Optional parameters: none Body: {:annotations [{:key string, :value string}], :lineItemId string, :operationId string, :productId string} Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.
(shiplineitems$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/shiplineitems
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:lineItems [{:lineItemId string, :productId string, :quantity integer}], :operationId string, :shipmentGroupId string, :shipmentInfos [{:carrier string, :shipmentId string, :trackingId string}]}
Marks line item(s) as shipped.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/shiplineitems Required parameters: merchantId, orderId Optional parameters: none Body: {:lineItems [{:lineItemId string, :productId string, :quantity integer}], :operationId string, :shipmentGroupId string, :shipmentInfos [{:carrier string, :shipmentId string, :trackingId string}]} Marks line item(s) as shipped.
(updatelineitemshippingdetails$ auth args body)
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:deliverByDate string, :lineItemId string, :operationId string, :productId string, :shipByDate string}
Updates ship by and delivery by dates for a line item.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/updatelineitemshippingdetails Required parameters: merchantId, orderId Optional parameters: none Body: {:deliverByDate string, :lineItemId string, :operationId string, :productId string, :shipByDate string} Updates ship by and delivery by dates for a line item.
(updatemerchantorderid$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/updatemerchantorderid
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:merchantOrderId string, :operationId string}
Updates the merchant order ID for a given order.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/updatemerchantorderid Required parameters: merchantId, orderId Optional parameters: none Body: {:merchantOrderId string, :operationId string} Updates the merchant order ID for a given order.
(updateshipment$ auth args body)
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/updateshipment
Required parameters: merchantId, orderId
Optional parameters: none
Body:
{:carrier string, :deliveryDate string, :operationId string, :shipmentId string, :status string, :trackingId string}
Updates a shipment's status, carrier, and/or tracking ID.
https://developers.google.com/shopping-contentapi/reference/rest/v2.1/orders/updateshipment Required parameters: merchantId, orderId Optional parameters: none Body: {:carrier string, :deliveryDate string, :operationId string, :shipmentId string, :status string, :trackingId string} Updates a shipment's status, carrier, and/or tracking ID.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close