REST Resource: productdeliverytime

Stay organized with collections Save and categorize content based on your preferences.

Resource: ProductDeliveryTime

The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the products resource instead.

JSON representation
{
  "productId": {
    object (ProductId)
  },
  "areaDeliveryTimes": [
    {
      object (AreaDeliveryTime)
    }
  ]
}
Fields
productId

object (ProductId)

Required. The id of the product.

areaDeliveryTimes[]

object (AreaDeliveryTime)

Required. A set of associations between DeliveryArea and DeliveryTime entries. The total number of areaDeliveryTimes can be at most 100.

ProductId

The Content API ID of the product.

JSON representation
{
  "productId": string
}
Fields
productId

string

The Content API ID of the product, in the form channel:contentLanguage:targetCountry:offerId.

AreaDeliveryTime

A pairing of DeliveryArea associated with a DeliveryTime for this product.

JSON representation
{
  "deliveryArea": {
    object (DeliveryArea)
  },
  "deliveryTime": {
    object (DeliveryTime)
  }
}
Fields
deliveryArea

object (DeliveryArea)

Required. The delivery area associated with deliveryTime for this product.

deliveryTime

object (DeliveryTime)

Required. The delivery time associated with deliveryArea for this product.

DeliveryArea

A delivery area for the product. Only one of countryCode or postalCodeRange must be set.

JSON representation
{
  "countryCode": string,
  "postalCodeRange": {
    object (PostalCodeRange)
  },
  "regionCode": string
}
Fields
countryCode

string

Required. The country that the product can be delivered to. Submit a unicode CLDR region such as US or CH.

postalCodeRange

object (PostalCodeRange)

A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS.

regionCode

string

A state, territory, or prefecture. This is supported for the United States, Australia, and Japan. Provide a subdivision code from the ISO 3166-2 code tables (US, AU, or JP) without country prefix (for example, "NY", "NSW", "03").

PostalCodeRange

A range of postal codes that defines the delivery area. Only set firstPostalCode when specifying a single postal code.

JSON representation
{
  "firstPostalCode": string,
  "lastPostalCode": string
}
Fields
firstPostalCode

string

Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*".

lastPostalCode

string

A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must have the same length as firstPostalCode: if firstPostalCode is a postal code then lastPostalCode must be a postal code too; if firstPostalCode is a pattern then lastPostalCode must be a pattern with the same prefix length. Ignored if not set, then the area is defined as being all the postal codes matching firstPostalCode.

DeliveryTime

A delivery time for this product.

JSON representation
{
  "minHandlingTimeDays": integer,
  "maxHandlingTimeDays": integer,
  "minTransitTimeDays": integer,
  "maxTransitTimeDays": integer
}
Fields
minHandlingTimeDays

integer

Required. The minimum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.

maxHandlingTimeDays

integer

Required. The maximum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.

minTransitTimeDays

integer

Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.

maxTransitTimeDays

integer

Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.

Methods

create

Creates or updates the delivery time of a product.

delete

Deletes the delivery time of a product.

get

Gets productDeliveryTime by productId.