- Resource: ProductDeliveryTime
- ProductId
- AreaDeliveryTime
- DeliveryArea
- PostalCodeRange
- DeliveryTime
- Methods
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 ( |
Fields | |
---|---|
product |
Required. The |
area |
Required. A set of associations between |
ProductId
The Content API ID of the product.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
product |
The Content API ID of the product, in the form |
AreaDeliveryTime
A pairing of DeliveryArea
associated with a DeliveryTime
for this product.
JSON representation |
---|
{ "deliveryArea": { object ( |
Fields | |
---|---|
delivery |
Required. The delivery area associated with |
delivery |
Required. The delivery time associated with |
DeliveryArea
A delivery area for the product. Only one of countryCode
or postalCodeRange
must be set.
JSON representation |
---|
{
"countryCode": string,
"postalCodeRange": {
object ( |
Fields | |
---|---|
country |
Required. The country that the product can be delivered to. Submit a unicode CLDR region such as |
postal |
A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS. |
region |
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, |
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 | |
---|---|
first |
Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: |
last |
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 |
DeliveryTime
A delivery time for this product.
JSON representation |
---|
{ "minHandlingTimeDays": integer, "maxHandlingTimeDays": integer, "minTransitTimeDays": integer, "maxTransitTimeDays": integer } |
Fields | |
---|---|
min |
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. |
max |
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. |
min |
Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered. |
max |
Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered. |
Methods |
|
---|---|
|
Creates or updates the delivery time of a product. |
|
Deletes the delivery time of a product. |
|
Gets productDeliveryTime by productId . |