Recommend products - AfterShip Personalization API

[url](../../docs/quickstart/authentication.md)

[filter key](../../docs/enum/filter_key.md)

[scenarios](../../docs/scenarios/recommendations/best_sellers.md)

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Allowed value:

application/json

Default:

application/json

as-store-id

string

required

The identifier of your Commerce store

Example:

f58a7bc4fb6d4719901906abde0c6f46

Body

type

required

Default algorithm configuration type.

Allowed values:

BEST_SELLERSBOUGHT_TOGETHERRANDOMNEW_ARRIVALCOMPLEMENTSSIMILAR

session_id

string

Session unique identifier. It is recommended to use this package to generate UUID.

Example:

47be3249-c1f4-446d-b652-8749be6ed577

include_filters

array[string]

Include products that correspond to the specified attribute. For the supported filter key, please refer to the filter key, and for the format of the filter, please refer to the following examples:

Conjunctive filtering: ["tags:Sale", "categories:Furniture"] means tags contain any of ('Sale') and categories contain any of ('Furniture')
Disjunctive filtering: ["tags:Sofa,Couch,Bed"] means tags contain any of ('Sofa', 'Couch', 'Bed')

exclude_filters

array[string]

Exclude products that correspond to the specified attribute. For the supported filter key, please refer to the filter key, and for the format of the filter, please refer to the following examples:

Conjunctive filtering: ["!tags:Sale", "!categories:Furniture"] means tags not contain any of ('Sale') and categories not contain any of ('Furniture')
Disjunctive filtering: ["!tags:Sofa,Couch,Bed"] means tags not contain any of ('Sofa', 'Couch', 'Bed')

limit

number

The number of products each page contains.

<= 100

Default:

Example:

products

array[PartialProduct]

This parameter is required for BOUGHT_TOGETHER, COMPLEMENTS, and SIMILAR types. For the meaning of products in different scenarios, please refer to scenarios.

string

Unique identifier generated by AfterShip.

Example:

f74f8af7578042b0991e104533158ad1

source_id

string

required

A unique identifier for the product.

Example:

00093d19495447a2a082bfe44d75658a

variants

array[object]

Variants of a product.