TestOrder

JSON representation
{
  "kind": string,
  "lineItems": [
    {
      object (TestOrderLineItem)
    }
  ],
  "shippingOption": string,
  "predefinedDeliveryAddress": string,
  "shippingCost": {
    object (Price)
  },
  "notificationMode": string,
  "enableOrderinvoices": boolean,
  "predefinedBillingAddress": string,
  "promotions": [
    {
      object (OrderPromotion)
    }
  ],
  "predefinedEmail": string,
  "predefinedPickupDetails": string,
  "pickupDetails": {
    object (TestOrderPickupDetails)
  },
  "deliveryDetails": {
    object (TestOrderDeliveryDetails)
  }
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#testOrder"

lineItems[]

object (TestOrderLineItem)

Required. Line items that are ordered. At least one line item must be provided.

shippingOption

string

Required. The requested shipping option.

Acceptable values are:

  • "economy"
  • "expedited"
  • "oneDay"
  • "sameDay"
  • "standard"
  • "twoDay"

predefinedDeliveryAddress

string

Required. Identifier of one of the predefined delivery addresses for the delivery.

Acceptable values are:

  • "dwight"
  • "jim"
  • "pam"

shippingCost

object (Price)

Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.

notificationMode

string

Restricted. Do not use.

enableOrderinvoices

boolean

Whether the orderinvoices service should support this order.

predefinedBillingAddress

string

Required. The billing address.

Acceptable values are:

  • "dwight"
  • "jim"
  • "pam"

promotions[]

object (OrderPromotion)

Promotions associated with the order.

predefinedEmail

string

Required. Email address of the customer.

Acceptable values are:

  • "pog.dwight.schrute@gmail.com"
  • "pog.jim.halpert@gmail.com"
  • "penpog.pam.beesly@gmail.comding"

predefinedPickupDetails

string

Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup.

Acceptable values are:

  • "dwight"
  • "jim"
  • "pam"

pickupDetails

object (TestOrderPickupDetails)

Overrides the predefined pickup details if provided.

deliveryDetails

object (TestOrderDeliveryDetails)

Overrides the predefined delivery details if provided.

TestOrderLineItem

JSON representation
{
  "product": {
    object (TestOrderLineItemProduct)
  },
  "quantityOrdered": integer,
  "shippingDetails": {
    object (OrderLineItemShippingDetails)
  },
  "returnInfo": {
    object (OrderLineItemReturnInfo)
  }
}
Fields
product

object (TestOrderLineItemProduct)

Required. Product data from the time of the order placement.

quantityOrdered

integer (uint32 format)

Required. Number of items ordered.

shippingDetails

object (OrderLineItemShippingDetails)

Required. Details of the requested shipping for the line item.

returnInfo

object (OrderLineItemReturnInfo)

Required. Details of the return policy for the line item.

TestOrderLineItemProduct

JSON representation
{
  "offerId": string,
  "targetCountry": string,
  "contentLanguage": string,
  "title": string,
  "price": {
    object (Price)
  },
  "condition": string,
  "gtin": string,
  "brand": string,
  "mpn": string,
  "variantAttributes": [
    {
      object (OrderLineItemProductVariantAttribute)
    }
  ],
  "itemGroupId": string,
  "imageLink": string,
  "fees": [
    {
      object (OrderLineItemProductFee)
    }
  ]
}
Fields
offerId

string

Required. An identifier of the item.

targetCountry

string

Required. The CLDR territory // code of the target country of the product.

contentLanguage

string

Required. The two-letter ISO 639-1 language code for the item.

Acceptable values are:

  • "en"
  • "fr"

title

string

Required. The title of the product.

price

object (Price)

Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.

condition

string

Required. Condition or state of the item.

Acceptable values are:

  • "new"

gtin

string

Global Trade Item Number (GTIN) of the item. Optional.

brand

string

Required. Brand of the item.

mpn

string

Manufacturer Part Number (MPN) of the item. Optional.

variantAttributes[]

object (OrderLineItemProductVariantAttribute)

Variant attributes for the item. Optional.

itemGroupId

string

Shared identifier for all variants of the same product. Optional.

fees[]

object (OrderLineItemProductFee)

Fees for the item. Optional.

TestOrderPickupDetails

JSON representation
{
  "pickupPersons": [
    {
      object (TestOrderPickupDetailsPickupPerson)
    }
  ],
  "locationCode": string,
  "pickupLocationAddress": {
    object (TestOrderAddress)
  },
  "pickupLocationType": string
}
Fields
pickupPersons[]

object (TestOrderPickupDetailsPickupPerson)

Required. all pickup persons set by users.

locationCode

string

Required. Code of the location defined by provider or merchant.

pickupLocationAddress

object (TestOrderAddress)

Required. Pickup location address.

pickupLocationType

string

Pickup location type.

Acceptable values are:

  • "locker"
  • "store"
  • "curbside"

TestOrderPickupDetailsPickupPerson

JSON representation
{
  "name": string,
  "phoneNumber": string
}
Fields
name

string

Required. Full name of the pickup person.

phoneNumber

string

Required. The phone number of the person picking up the items.

TestOrderAddress

JSON representation
{
  "recipientName": string,
  "streetAddress": [
    string
  ],
  "locality": string,
  "region": string,
  "country": string,
  "postalCode": string,
  "isPostOfficeBox": boolean,
  "fullAddress": [
    string
  ]
}
Fields
recipientName

string

Name of the recipient.

streetAddress[]

string

Street-level part of the address.

locality

string

City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

region

string

Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

country

string

CLDR country code (e.g. "US").

postalCode

string

Postal Code or ZIP (e.g. "94043").

isPostOfficeBox

boolean

Whether the address is a post office box.

fullAddress[]

string

Strings representing the lines of the printed label for mailing the order, for example:

John Smith
1600 Amphitheatre Parkway
Mountain View, CA, 94043
United States

TestOrderDeliveryDetails

JSON representation
{
  "address": {
    object (TestOrderAddress)
  },
  "phoneNumber": string
}
Fields
address

object (TestOrderAddress)

The delivery address

phoneNumber

string

The phone number of the person receiving the delivery.