Website Fast Tags

title: Reference description: Reference docs for using Flexport Website Fast Tags.

Reference

Web Components

Flexport offers pre-built web components for simple and easy fast tag integration.

deliverr-tag

The deliverr-tag web component adds a fast tag to your page when a visitor comes from a zip code that is eligible for fast shipping for the matching skus.

Attributes

data-dskus
Accepts: string[]
Default: None

Accepts a JSON serializable array of SKUS as they are identified on the Flexport platform. View your inventory in the Flexport seller portal for details.

data-skus
Accepts: string[]
Default: None

Accepts a JSON serializable array of SKUS associated to products in your seller account.

data-sellerid
Accepts: string
Default: None

Your seller id as provided to you by Flexport

data-use-service-level
Accepts: min, max
Default: max

Sets the method of identifying the level of service for a set of products when difference service levels are available.

  • max will display the slowest service level available
  • min will display the shortest service level available
data-cart-size
number

The total dollar amount of items in the cart. Recommended when using cart minimums.

data-price
number

The dollar amount of the product assigned to the fast tag. Recommended when using cart minimums.

deliverr-tag-extended

The deliverr-tag-extended web component adds a fast tag to your page when a visitor comes from a zip code that is eligible for fast shipping for the matching It also includes a zip code form that allows a visitor to manually enter their zip code rather than solely relying on Flexport's zip code service.

Attributes

data-dskus
Accepts: string[]
Default: None

Accepts a JSON serializable array of SKUS as they are identified on the Flexport platform. View your inventory in the Flexport seller portal for details.

data-skus
Accepts: string[]
Default: None

Accepts a JSON serializable array of SKUS associated to products in your seller account.

data-sellerid
Accepts: string
Default: None

Your seller id as provided to you by Flexport.

data-use-service-level
Accepts: min, max
Default: max

Sets the method of identifying the level of service for a set of products when difference service levels are available.

  • max will display the slowest service level available
  • min will display the shortest service level available
data-cart-size
number

The total dollar amount of items in the cart. Recommended when using cart minimums.

data-price
number

The dollar amount of the product assigned to the fast tag. Recommended when using cart minimums.

DeliverrFastTags Global

An object storing details about the Flexport Fast Tag library.

appConfig: App Configuration

The appConfig property of the DeliverrFastTags global represents non default behavior applied to the whole application.

sellerId (optional)
string

The seller id as used by Flexport. Can be found in Flexport's seller portal

cartMinimum (optional)
boolean

Toggles use of the cart minimum feature. If set to true, the sellerId must also be set. If not set, cart minimums will be inactive

API Client

The Flexport Website Fast Tags library includes an http client for connecting to the Flexport API. This is made available through the window object on window.DeliverrApi.

getShippingOptions

(options: Options) => Promise<ShippingOptions>

Options

destination (required)
Address

An Address object that identifies the address being shipped to.

Address object:

street1 (required)
string

The address of the location being shipped to.

street2 (optional)
string

Alternative address information of the location being shipped to.

zip (required)
string

The zip code of the location being shipped to

city (required)
string

The city of the location being shipped to

state (required)
string

The state of the location being shipped to.

country (required)
string

The country of the location being shipped to. Flexport currently only supports 'US'.

skus (optional)
string[]

The array of SKUs for the product(s) being checked. If used, options must also have a sellerId property.

sellerId (optional)
string

Your seller id as provided to you by Flexport. If used, options must also have a skus property.

dskus (optional)
string[]

The array of Flexport provided SKUS for the product(s) being checked.

Note

One of:
  • `skus` and `sellerId`
  • `dskus`
must be passed in.

ShippingOptions

name
string

The name of the service level provided for that. If you're using logistics API's create order API, pass this field into `ship method name`

shippingDays
number

The number of days it takes to ship the product

arrivesBy
string

The confirmed arrival date for the product if ordered by within the guarantee period.

code
string

An identifier for the service level being offered for that product

note (optional)
string

In some cases an optional note field is returned in the response. This occurs when:

  • The customer address is a PO Box
  • The cart contains a mix of products with different shipping speeds

Example

{
    "name": "Free NextDay Delivery",
    "shippingDays": 1,
    "arrivesBy": "Arrives by Tuesday, October 13th",
    "code": "Deliverr-1-Day"
}
© 2024 Flexport, Inc.