Options
All
  • Public
  • Public/Protected
  • All
Menu

Module shopperDeliveryEstimates

Index

References

DeliveryEstimatesResult

Re-exports DeliveryEstimatesResult

DeliveryEstimatesResult

Re-exports DeliveryEstimatesResult

DeliveryWindow

Re-exports DeliveryWindow

DeliveryWindow

Re-exports DeliveryWindow

Destination

Re-exports Destination

Destination

Re-exports Destination

ErrorResponse

Re-exports ErrorResponse

ErrorResponse

Re-exports ErrorResponse

GetDeliveryEstimatesPersonalizedEnum

Re-exports GetDeliveryEstimatesPersonalizedEnum

GetDeliveryEstimatesPersonalizedEnum

Re-exports GetDeliveryEstimatesPersonalizedEnum

ProductDeliveryEstimate

Re-exports ProductDeliveryEstimate

ProductDeliveryEstimate

Re-exports ProductDeliveryEstimate

ShippingOption

Re-exports ShippingOption

ShippingOption

Re-exports ShippingOption

ShopperDeliveryEstimates

Re-exports ShopperDeliveryEstimates

ShopperDeliveryEstimates

Re-exports ShopperDeliveryEstimates

ShopperDeliveryEstimatesParameters

Re-exports ShopperDeliveryEstimatesParameters

ShopperDeliveryEstimatesParameters

Re-exports ShopperDeliveryEstimatesParameters

ShopperDeliveryEstimatesPathParameters

Re-exports ShopperDeliveryEstimatesPathParameters

ShopperDeliveryEstimatesPathParameters

Re-exports ShopperDeliveryEstimatesPathParameters

ShopperDeliveryEstimatesQueryParameters

Re-exports ShopperDeliveryEstimatesQueryParameters

ShopperDeliveryEstimatesQueryParameters

Re-exports ShopperDeliveryEstimatesQueryParameters

defaultBaseUri

Re-exports defaultBaseUri

getDeliveryEstimatesPathParameters

Re-exports getDeliveryEstimatesPathParameters

getDeliveryEstimatesPathParameters

Re-exports getDeliveryEstimatesPathParameters

getDeliveryEstimatesQueryParameters

Re-exports getDeliveryEstimatesQueryParameters

getDeliveryEstimatesQueryParameters

Re-exports getDeliveryEstimatesQueryParameters

Type aliases

DeliveryEstimatesResult

DeliveryEstimatesResult: { productDeliveryEstimates: Array<ProductDeliveryEstimate> } & {}
property

productDeliveryEstimates: The array of per-product delivery estimate entries, one per requested product that has estimates. The array is empty when the platform has no estimates for any of the requested products.

DeliveryWindow

DeliveryWindow: { endAt: string; startAt: string } & {}
property

startAt: The earliest expected delivery timestamp (inclusive).

property

endAt: The latest expected delivery timestamp (inclusive).

Destination

Destination: { countryCode: string; postalCode: string } & {}
property

postalCode: The destination postal code.

  • Min Length: 1
  • Max Length: 20
property

countryCode: The destination country as an ISO 3166-1 alpha-2 code.

  • Pattern: /^[A-Z][A-Z]$/

ErrorResponse

ErrorResponse: { detail: string; instance?: undefined | string; title: string; type: string } & {}
property

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

  • Max Length: 256
property

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048
property

detail: A human-readable explanation specific to this occurrence of the problem.

property

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048

GetDeliveryEstimatesPersonalizedEnum

GetDeliveryEstimatesPersonalizedEnum: "none"

ProductDeliveryEstimate

ProductDeliveryEstimate: { destination: Destination; productId: string; shippingOptions: Array<ShippingOption> } & {}
property

productId: The id (SKU) of the product.

  • Min Length: 1
  • Max Length: 100
property

destination:

property

shippingOptions: The array of shipping method estimates for the product at the destination. Each entry corresponds to one applicable shipping method.

ShippingOption

ShippingOption: { carrier?: undefined | string; currency?: undefined | string; deliveryWindow?: DeliveryWindow; description?: undefined | string; name?: undefined | string; nonDeliverableReason?: undefined | string; orderCutoffAt?: undefined | string; price?: undefined | number; shippingMethodId: string } & {}
property

shippingMethodId: The identifier of the shipping method (matches the B2C Commerce ShippingMethod.ID).

  • Min Length: 1
  • Max Length: 256
property

name: The localized name of the shipping method.

  • Min Length: 1
  • Max Length: 256
property

description: The localized description of the shipping method.

  • Min Length: 1
  • Max Length: 4000
property

carrier: The carrier the provider resolved for this shipping method (for example, UPS, FedEx, USPS). May be omitted when the provider cannot or does not identify a single carrier.

  • Min Length: 1
  • Max Length: 256
property

price: The estimated shipping cost for this shipping method, in the currency given by currency. May be omitted when the provider cannot or does not return a price.

property

currency: The ISO 4217 currency code for price. Defaults to the site's default currency. Omitted when price is omitted.

  • Pattern: /^([A-Z][A-Z][A-Z]|N/A)$/
property

deliveryWindow: The estimated delivery window for this shipping method. Omitted when nonDeliverableReason is set.

property

orderCutoffAt: The latest timestamp by which an order must be placed for the deliveryWindow to apply. Clients compare this to the current time to decide whether the estimate is still valid. Omitted when not applicable. Sub-day RFC 3339 precision.

property

nonDeliverableReason: A SCREAMING_SNAKE_CASE code identifying why the provider could not deliver via this shipping method. This is not localized and not intended to be shown directly to shoppers. This field may be omitted when the provider cannot or does not identify a single reason. Provider implementations may emit additional codes. Omitted when deliveryWindow is set.

  • Min Length: 1
  • Max Length: 256

ShopperDeliveryEstimatesParameters

All parameters that are used by ShopperDeliveryEstimates.

ShopperDeliveryEstimatesPathParameters

ShopperDeliveryEstimatesPathParameters: Partial<getDeliveryEstimatesPathParameters & {}>

All path parameters that are used by at least one ShopperDeliveryEstimates method.

ShopperDeliveryEstimatesQueryParameters

ShopperDeliveryEstimatesQueryParameters: Partial<getDeliveryEstimatesQueryParameters & {}>

All query parameters that are used by at least one ShopperDeliveryEstimates method.

getDeliveryEstimatesPathParameters

getDeliveryEstimatesPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getDeliveryEstimatesQueryParameters

getDeliveryEstimatesQueryParameters: { countryCode: string; personalized?: undefined | "none"; postalCode: string; productIds: Array<string>; siteId: string }

Type declaration

  • countryCode: string
  • Optional personalized?: undefined | "none"
  • postalCode: string
  • productIds: Array<string>
  • siteId: string

Variables

Const defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-delivery-estimates/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-delivery-estimates/v1"

Generated using TypeDoc