Evaluate strategy

Evaluate a strategy against provided context to return the desired experience.

POST /api/public/strategy/evaluate

Evaluate Strategy

cURL

curl --request POST \
  --url https://start.aftersell.app/api/public/strategy/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-Strategy-Api-Key: <api-key>' \
  --data '
{
  "shopDomain": "<string>",
  "strategyId": "<string>",
  "context": {
    "products": [
      {
        "productId": "<string>",
        "variantId": "<string>",
        "quantity": 1,
        "price": 1,
        "handle": "<string>",
        "title": "<string>",
        "vendor": "<string>",
        "productType": "<string>",
        "tags": [
          "<string>"
        ],
        "collections": [
          "<string>"
        ],
        "metafields": [
          {
            "namespace": "<string>",
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "cartToken": "<string>",
    "checkoutToken": "<string>",
    "sessionId": "<string>",
    "cart": {
      "subtotal": 1,
      "itemCount": 1,
      "lineCount": 1,
      "attributes": {},
      "notes": "<string>"
    },
    "customer": {
      "customerId": "<string>",
      "tags": [
        "<string>"
      ],
      "countryCode": "<string>",
      "provinceCode": "<string>",
      "locale": "<string>",
      "orderCount": 1,
      "totalSpent": 1,
      "acceptsMarketing": true
    },
    "session": {
      "landingUrl": "<string>",
      "currencyCode": "<string>",
      "shippingCountryCode": "<string>",
      "shippingProvinceCode": "<string>",
      "shippingMethod": "<string>"
    },
    "visitorId": "<string>",
    "localization": {
      "country": "AU",
      "currency": "AUD",
      "language": "en-AU"
    }
  }
}
'

200

Example

{ "success": true, "products": [ { "productId": "<string>", "handle": "<string>", "title": "<string>", "vendor": "<string>", "productType": "<string>", "price": "<string>", "compareAtPrice": "<string>", "currencyCode": "<string>", "availableForSale": true, "description": "<string>", "url": "<string>", "tags": [ "<string>" ], "collectionIds": [ "<string>" ], "images": [ { "src": "<string>", "altText": "<string>", "position": 123 } ], "variants": [ { "variantId": "<string>", "title": "<string>", "price": "<string>", "compareAtPrice": "<string>", "currencyCode": "<string>", "availableForSale": true, "sku": "<string>", "image": { "src": "<string>" }, "selectedOptions": [ { "name": "<string>", "value": "<string>" } ] } ] } ], "evaluationId": "<string>", "resolution": { "strategyId": "<string>", "matchedRuleIds": [ "<string>" ], "selectionMethod": "<string>", "fallbackUsed": true }, "meta": { "servedFromCache": true, "processingTimeMs": 123, "data": {}, "explanation": "<string>" }, "errors": [ { "code": "<string>", "message": "<string>" } ] }

Authorizations

X-Strategy-Api-Key · string · header · required

Body

application/json

shopDomain · string · required

Your store's permanent domain

strategyId · string · required

The strategy ID to evaluate (a single 24-char hex MongoDB ObjectId)

context · object · required

Show child attributes

surface · enum<string>

Optional surface the evaluation is running on. Recorded for tracing and reporting.

Available options: checkout, post_purchase, thank_you, custom, cart, pdp

Response

200

application/json

Evaluation successful

success · boolean

Whether the evaluation succeeded

products · object[]

Fully enriched recommended products

Show child attributes

evaluationId · string

Unique identifier for this evaluation. Echo it back as a line item property (e.g. __as_offer_id) when a shopper adds a recommended product, so the resulting order attributes back to this specific evaluation in AfterSell reporting. Present on successful evaluations; absent on error responses that short-circuit before evaluation.

resolution · object

Show child attributes

meta · object

Show child attributes

errors · object[]

Present only when errors occur

Show child attributes