happygapi.content.orders — happygapi 0.4.7

Content API for Shopping: orders. Manage your product listings and accounts for Google Shopping See: https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders

acknowledge$ clj

(acknowledge$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/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-content/v2/api/reference/rest/v2.1/orders/advancetestorder

Required parameters: orderId, merchantId

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-content/v2/api/reference/rest/v2.1/orders/cancel

Required parameters: orderId, merchantId

Optional parameters: none

Body:

{:reasonText string, :operationId string, :reason string}

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

cancellineitem$ clj

(cancellineitem$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/cancellineitem

Required parameters: orderId, merchantId

Optional parameters: none

Body:

{:lineItemId string, :reasonText string, :quantity integer, :operationId string, :reason string, :productId string}

Cancels a line item, making a full refund.

canceltestorderbycustomer$ clj

(canceltestorderbycustomer$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/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-content/v2/api/reference/rest/v2.1/orders/createtestorder

Required parameters: merchantId

Optional parameters: none

Body:

{:templateName string, :testOrder {:promotions [OrderPromotion], :predefinedPickupDetails string, :shippingOption string, :pickupDetails TestOrderPickupDetails, :enableOrderinvoices boolean, :predefinedBillingAddress string, :lineItems [TestOrderLineItem], :deliveryDetails TestOrderDeliveryDetails, :shippingCost Price, :kind string, :predefinedDeliveryAddress string, :predefinedEmail string, :notificationMode string}, :country string}

Sandbox only. Creates a test order.

createtestreturn$ clj

(createtestreturn$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/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-content/v2/api/reference/rest/v2.1/orders/get

Required parameters: orderId, merchantId

Optional parameters: none

Retrieves an order from your Merchant Center account.

getbymerchantorderid$ clj

(getbymerchantorderid$ auth parameters)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/getbymerchantorderid

Required parameters: merchantOrderId, merchantId

Optional parameters: none

Retrieves an order using merchant order ID.

gettestordertemplate$ clj

(gettestordertemplate$ auth parameters)

https://developers.google.com/shopping-content/v2/api/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-content/v2/api/reference/rest/v2.1/orders/instorerefundlineitem

Required parameters: orderId, merchantId

Optional parameters: none

Body:

{:lineItemId string, :reasonText string, :priceAmount {:value string, :currency string}, :operationId string, :taxAmount {:value string, :currency string}, :reason string, :productId string, :quantity integer}

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-content/v2/api/reference/rest/v2.1/orders/list

Required parameters: merchantId

Optional parameters: maxResults, statuses, acknowledged, orderBy, placedDateEnd, pageToken, placedDateStart

Lists the orders in your Merchant Center account.

refunditem$ clj

(refunditem$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/refunditem

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:reasonText string, :shipping {:fullRefund boolean, :amount Price}, :items [{:fullRefund boolean, :productId string, :quantity integer, :amount MonetaryAmount, :lineItemId string}], :reason string, :operationId string}

Issues a partial or total refund for items and shipment.

refundorder$ clj

(refundorder$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/refundorder

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:reasonText string, :amount {:priceAmount Price, :taxAmount Price}, :reason string, :fullRefund boolean, :operationId string}

Issues a partial or total refund for an order.

rejectreturnlineitem$ clj

(rejectreturnlineitem$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/rejectreturnlineitem

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:reason string, :reasonText string, :productId string, :lineItemId string, :quantity integer, :operationId string}

Rejects return on an line item.

returnrefundlineitem$ clj

(returnrefundlineitem$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/returnrefundlineitem

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:priceAmount {:value string, :currency string}, :productId string, :quantity integer, :operationId string, :reasonText string, :lineItemId string, :taxAmount {:value string, :currency string}, :reason string}

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.

setlineitemmetadata$ clj

(setlineitemmetadata$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/setlineitemmetadata

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:lineItemId string, :operationId string, :productId string, :annotations [{:key string, :value 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-content/v2/api/reference/rest/v2.1/orders/shiplineitems

Required parameters: orderId, merchantId

Optional parameters: none

Body:

{:operationId string, :shipmentInfos [{:trackingId string, :shipmentId string, :carrier string}], :lineItems [{:productId string, :lineItemId string, :quantity integer}], :shipmentGroupId string}

Marks line item(s) as shipped.

updatelineitemshippingdetails$ clj

(updatelineitemshippingdetails$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/updatelineitemshippingdetails

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:productId string, :shipByDate string, :deliverByDate string, :operationId string, :lineItemId string}

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

updatemerchantorderid$ clj

(updatemerchantorderid$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/updatemerchantorderid

Required parameters: orderId, merchantId

Optional parameters: none

Body:

{:operationId string, :merchantOrderId string}

Updates the merchant order ID for a given order.

updateshipment$ clj

(updateshipment$ auth parameters body)

https://developers.google.com/shopping-content/v2/api/reference/rest/v2.1/orders/updateshipment

Required parameters: merchantId, orderId

Optional parameters: none

Body:

{:readyPickupDate string, :undeliveredDate string, :carrier string, :trackingId string, :lastPickupDate string, :shipmentId string, :status string, :operationId string, :deliveryDate string, :scheduledDeliveryDetails {:carrierPhoneNumber string, :scheduledDate string}}

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