happygapi.content.orders — happygapi 0.4.2

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$ clj

(acknowledge$ auth parameters 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.

advancetestorder$ clj

(advancetestorder$ auth parameters)

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$ clj

(cancel$ auth parameters 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.

cancellineitem$ clj

(cancellineitem$ auth parameters 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.

canceltestorderbycustomer$ clj

(canceltestorderbycustomer$ auth parameters body)

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$ clj

(createtestorder$ auth parameters 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.

createtestreturn$ clj

(createtestreturn$ auth parameters 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.

get$ clj

(get$ auth parameters)

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$ clj

(getbymerchantorderid$ auth parameters)

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$ clj

(gettestordertemplate$ auth parameters)

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$ clj

(instorerefundlineitem$ auth parameters 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.

list$ clj

(list$ auth parameters)

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$ clj

(rejectreturnlineitem$ auth parameters 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.

returnrefundlineitem$ clj

(returnrefundlineitem$ auth parameters 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.

setlineitemmetadata$ clj

(setlineitemmetadata$ auth parameters 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.

shiplineitems$ clj

(shiplineitems$ auth parameters 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.

updatelineitemshippingdetails$ clj

(updatelineitemshippingdetails$ auth parameters body)

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$ clj

(updatemerchantorderid$ auth parameters 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.

updateshipment$ clj

(updateshipment$ auth parameters 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.