{"openapi":"3.1.0","info":{"title":"Henry Labs API Playground","version":"1.0.0","description":"Playground for Henry Labs API endpoints","contact":{"name":"Henry Labs API Support","email":"support@henrylabs.ai"}},"servers":[{"url":"https://api.henrylabs.ai/v1","description":"Production server"}],"tags":[{"name":"Product","description":"Product search, details, and data enrichment"},{"name":"Cart","description":"Universal user shopping cart management"},{"name":"Order","description":"Order management post purchase"},{"name":"Merchant","description":"Merchant information and status"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/product/search/status":{"get":{"operationId":"productSearchStatus","summary":"Product Search Status","description":"Check the status of a product search retrieval job and get results when ready.","tags":["Product"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"refId","schema":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$","description":"Reference ID used for checking status","example":"prs-ref_3fa85f64-5717-4562-b3fc"},"required":true,"description":"Reference ID used for checking status"}],"responses":{"200":{"description":"Product search status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productSearchStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/product/search":{"post":{"operationId":"productSearch","summary":"Product Search","description":"Search for products by text query or image input. Requests are async by default, or use mode=sync to wait up to 30 seconds for completion.","tags":["Product"],"security":[{"ApiKeyAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productSearchInput"},"examples":{"globalTextSearch":{"summary":"Global text search","value":{"type":"global","filters":{"type":"text","query":"Air Max Shoes","country":"US","price":{"min":1,"max":100,"currency":"USD"},"sortBy":"price-low-to-high"},"mode":"async","limit":40,"cursor":0}},"globalImageUrlSearch":{"summary":"Global image search with imageUrl","value":{"type":"global","filters":{"type":"image","imageUrl":"https://static.nike.com/a/images/t_web_pdp_535_v2/f_auto/example.png","country":"US"},"mode":"sync","limit":10,"cursor":0}},"globalImageBase64Search":{"summary":"Global image search with base64 imageUrl","value":{"type":"global","filters":{"type":"image","imageUrl":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","country":"US"},"mode":"async","limit":5,"cursor":0}},"merchantSearch":{"summary":"Merchant search","value":{"type":"merchant","filters":{"merchant":"nike.com","price":{"min":1,"max":100,"currency":"USD"}},"mode":"async","limit":20,"cursor":0}}}}}},"responses":{"201":{"description":"Product search queued successfully, use refId to check status and retrieve results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productSearchStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart":{"post":{"operationId":"cartCreate","summary":"Cart Create","description":"Create a cart with one or more items and get a checkout URL","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"requestBody":{"content":{"application/json":{"example":{"items":[{"link":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205","quantity":2,"selectedOptions":["regular","black","10-w"],"metadata":{"creatorSource":"Frank Herbert"}}],"settings":{"options":{"allowPartialPurchase":true,"collectBuyerEmail":"required","collectBuyerAddress":"optional","collectBuyerPhone":"off"},"commissionFeeFixed":{"value":1.99,"currency":"USD"},"commissionFeePercent":10,"events":[]}},"schema":{"$ref":"#/components/schemas/cartCreateInput"}}}},"responses":{"201":{"description":"Cart created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}},"get":{"operationId":"cartFetch","summary":"Cart Fetch","description":"Fetch a list of carts with optional filtering by cart ID or tags.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"cartId","schema":{"description":"Filter by a specific cart ID","example":"crt_sa2aEsCz9PRM","type":"string"},"description":"Filter by a specific cart ID"},{"in":"query","name":"tags","schema":{"description":"Filter carts by key-value tags","example":{"userId":"BennyJ"},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":"Filter carts by key-value tags"},{"in":"query","name":"cursor","schema":{"description":"Cursor returned from the previous response","example":"2023-01-01T00:00:00Z","type":"string"},"description":"Cursor returned from the previous response"},{"in":"query","name":"limit","schema":{"default":20,"description":"Limit the number of results","example":20,"type":"number","minimum":1,"maximum":100},"description":"Limit the number of results"}],"responses":{"200":{"description":"Carts fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartFetchResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/{cartId}/item":{"post":{"operationId":"cartAddItem","summary":"Cart Add Item","description":"Add an item to an existing cart.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"}],"requestBody":{"content":{"application/json":{"example":{"item":{"link":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205","quantity":1,"selectedOptions":["regular","black","10-w"],"metadata":{"creatorSource":"Frank Herbert"}}},"schema":{"$ref":"#/components/schemas/cartAddItemInput"}}}},"responses":{"200":{"description":"Cart item added successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"404":{"description":"Cart not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}},"delete":{"operationId":"cartRemoveItem","summary":"Cart Remove item","description":"Remove an item from a cart by its unique identifier","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"},{"in":"query","name":"link","schema":{"type":"string","format":"uri","description":"Direct product URL","example":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"},"required":true,"description":"Direct product URL"}],"responses":{"200":{"description":"Cart item removed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"404":{"description":"Cart not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}},"put":{"operationId":"cartUpdateItem","summary":"Cart Update Item","description":"Update an item in an existing cart.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"}],"requestBody":{"content":{"application/json":{"example":{"item":{"link":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205","quantity":1,"selectedOptions":["regular","black","10-w"],"metadata":{"creatorSource":"Frank Herbert"}}},"schema":{"type":"object","properties":{"item":{"description":"Item to update (can be object or stringified JSON)","$ref":"#/components/schemas/cartItemInput"}},"required":["item"]}}}},"responses":{"200":{"description":"Cart item updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"404":{"description":"Cart not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/{cartId}":{"delete":{"operationId":"cartDelete","summary":"Cart Delete","description":"Delete a cart by its unique identifier","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"}],"responses":{"200":{"description":"Cart deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"404":{"description":"Cart not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/checkout/status":{"get":{"operationId":"cartDetailsStatus","summary":"Cart Details Status","description":"Check the status of a cart details retrieval job and get results when ready.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"refId","schema":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$","description":"Reference ID used for checking status","example":"ckd-ref_3fa85f64-5717-4562-b3fc"},"required":true,"description":"Reference ID used for checking status"}],"responses":{"200":{"description":"Cart details status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartDetailsStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/{cartId}/details":{"post":{"operationId":"cartDetails","summary":"Cart Details","description":"Retrieve detailed information about a cart. Requests are async by default, or use mode=sync to wait up to 30 seconds for completion.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"}],"requestBody":{"content":{"application/json":{"example":{"buyer":{"shippingAddress":{"line1":"123 Main St","line2":"Apt 4B","city":"Anytown","province":"CA","postalCode":"12345","countryCode":"US"}},"coupons":["SUMMER21","FREESHIP"],"mode":"async"},"schema":{"$ref":"#/components/schemas/cartDetailsInput"}}}},"responses":{"201":{"description":"Cart detail jobs queued successfully, use refIds to check status and retrieve results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartDetailsResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/purchase/status":{"get":{"operationId":"cartPurchaseStatus","summary":"Cart Purchase Status","description":"Check the status of a cart purchase job and get results when ready.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"refId","schema":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$","description":"Reference ID used for checking status","example":"ckp-ref_3fa85f64-5717-4562-b3fc"},"required":true,"description":"Reference ID used for checking status"}],"responses":{"200":{"description":"Cart purchase status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartPurchaseStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/cart/{cartId}/purchase":{"post":{"operationId":"cartPurchase","summary":"Cart Purchase","description":"Initiate the purchase process for a cart. Requests are async by default, or use mode=sync to wait up to 30 seconds for completion.","tags":["Cart"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"path","name":"cartId","schema":{"type":"string","description":"Unique identifier for the cart","example":"crt_sa2aEsCz9PRM"},"required":true,"description":"Unique identifier for the cart"}],"requestBody":{"content":{"application/json":{"example":{"buyer":{"name":{"firstName":"John","middleName":"A.","lastName":"Doe"},"email":"johnadoe@example.com","phone":"+1234567890","shippingAddress":{"line1":"123 Main St","line2":"Apt 4B","city":"Anytown","province":"CA","postalCode":"12345","countryCode":"US"},"card":{"nameOnCard":{"firstName":"John","middleName":"A.","lastName":"Doe"},"details":{"cardToken":"card_live_SimDpKU9cmU7tvdUXHzOeLudtgfadQVnbof"},"billingAddress":{"line1":"123 Main St","line2":"Apt 4B","city":"Anytown","province":"CA","postalCode":"12345","countryCode":"US"}}},"mode":"async"},"schema":{"$ref":"#/components/schemas/cartPurchaseInput"}}}},"responses":{"201":{"description":"Cart purchase queued successfully, use refId to check status and retrieve results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartPurchaseStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/merchants":{"get":{"operationId":"merchantsFetch","summary":"Merchants Fetch","description":"Fetch a list of merchants with optional filtering and pagination.","tags":["Merchants"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"cursor","schema":{"description":"Cursor returned from the previous response","example":"2023-01-01T00:00:00Z","type":"string"},"description":"Cursor returned from the previous response"},{"in":"query","name":"limit","schema":{"default":20,"description":"Limit the number of results","example":20,"type":"number","minimum":1,"maximum":100},"description":"Limit the number of results"},{"in":"query","name":"host","schema":{"description":"Filter merchants by host","example":"nike.com","type":"string","minLength":1},"description":"Filter merchants by host"},{"in":"query","name":"name","schema":{"description":"Filter merchants by name (partial match)","example":"nike","type":"string","minLength":1},"description":"Filter merchants by name (partial match)"},{"in":"query","name":"categories","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["automotive","baby_and_kids","ecommerce","electronics_and_gadgets","fashion_and_accessories","finance","food","health_and_beauty","home_and_living","lifestyle_and_entertainment","other","sports_and_outdoor","travel","education"]}}}],"responses":{"200":{"description":"Merchants fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/merchantsFetchResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/orders":{"get":{"operationId":"ordersFetch","summary":"Orders Fetch","description":"Fetch a list of orders with optional filtering and pagination.","tags":["Orders"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"cursor","schema":{"description":"Cursor returned from the previous response","example":"2023-01-01T00:00:00Z","type":"string"},"description":"Cursor returned from the previous response"},{"in":"query","name":"limit","schema":{"default":20,"description":"Limit the number of results","example":20,"type":"number","minimum":1,"maximum":100},"description":"Limit the number of results"},{"in":"query","name":"status","schema":{"description":"Filter orders by status","example":"complete","type":"string","enum":["pending","processing","complete","cancelled"]},"description":"Filter orders by status"},{"in":"query","name":"cartId","schema":{"description":"Filter orders by cart ID","example":"sa2aEsCz9PRM","type":"string"},"description":"Filter orders by cart ID"}],"responses":{"200":{"description":"Orders fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersFetchResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/product/details/status":{"get":{"operationId":"productDetailsStatus","summary":"Product Details Status","description":"Check the status of a product details retrieval job and get results when ready.","tags":["Product"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"refId","schema":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$","description":"Reference ID used for checking status","example":"prd-ref_3fa85f64-5717-4562-b3fc"},"required":true,"description":"Reference ID used for checking status"}],"responses":{"200":{"description":"Product details status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productDetailsStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}},"/product/details":{"post":{"operationId":"productDetails","summary":"Product Details","description":"Fetch detailed information about a product from a given URL. Requests are async by default, or use mode=sync to wait up to 30 seconds for completion.","tags":["Product"],"security":[{"ApiKeyAuth":[]}],"requestBody":{"content":{"application/json":{"example":{"link":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205","variant":{"size":"10","color":"Black"},"country":"US","mode":"async"},"schema":{"$ref":"#/components/schemas/productDetailsInput"}}}},"responses":{"201":{"description":"Product details queued successfully, use refId to check status and retrieve results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productDetailsStatusResponse"}}}},"400":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status","message"],"additionalProperties":false}}}}}}}},"components":{"schemas":{"productSearchInput":{"oneOf":[{"$ref":"#/components/schemas/productSearchGlobalInput"},{"$ref":"#/components/schemas/productSearchMerchantInput"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"global":"#/components/schemas/productSearchGlobalInput","merchant":"#/components/schemas/productSearchMerchantInput"}}},"productSearchGlobalInput":{"type":"object","properties":{"type":{"type":"string","const":"global"},"filters":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text","description":"Search using a text query","example":"text"},"query":{"type":"string","minLength":1,"description":"Search query","example":"Air Max Shoes"},"country":{"description":"Country code for the search results","example":"US","type":"string"},"price":{"type":"object","properties":{"min":{"description":"Minimum price filter","example":1,"type":"number","exclusiveMinimum":0,"maximum":1000000},"max":{"description":"Maximum price filter","example":100,"type":"number","exclusiveMinimum":0,"maximum":1000000},"currency":{"description":"Currency code","example":"USD","type":"string"}}},"sortBy":{"description":"Sort by price","example":"price-low-to-high","type":"string","enum":["price-low-to-high","price-high-to-low"]}},"required":["type","query"]},{"type":"object","properties":{"type":{"type":"string","const":"image","description":"Search using an image input","example":"image"},"imageUrl":{"type":"string","minLength":1,"description":"Image input to search with Google Lens. Accepts a remote HTTP(S) URL, data URL, or base64-encoded image payload.","example":"https://static.nike.com/a/images/t_web_pdp_535_v2/f_auto/example.png"},"country":{"description":"Country code for the search results","example":"US","type":"string"}},"required":["type","imageUrl"]}],"type":"object"},"mode":{"default":"async","type":"string","enum":["async","sync"]},"limit":{"default":20,"description":"Limit the number of results","example":20,"type":"number","minimum":1,"maximum":100},"cursor":{"description":"Cursor returned from the previous response","example":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["type","filters"]},"productSearchMerchantInput":{"type":"object","properties":{"type":{"type":"string","const":"merchant"},"query":{"description":"Optional text query to narrow the merchant-scoped search. When omitted, the merchant's catalog browse is returned (implementation varies per merchant).","example":"running shoes","type":"string","minLength":1},"filters":{"type":"object","properties":{"merchant":{"type":"string","minLength":1,"description":"Merchant to scope the search to. Accepts a case-insensitive merchant name (e.g. 'Nike'), a host (e.g. 'nike.com'), or any URL from which the host can be derived.","example":"nike.com"}},"required":["merchant"]},"mode":{"default":"async","type":"string","enum":["async","sync"]},"limit":{"default":20,"description":"Limit the number of results","example":20,"type":"number","minimum":1,"maximum":100},"cursor":{"description":"Cursor returned from the previous response","example":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["type","filters"]},"cartCreateInput":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/cartItemInput"},"description":"Items to include in the cart"},"settings":{"$ref":"#/components/schemas/cartSettings"},"tags":{"description":"Key-value tags to associate with the cart","examples":[{"region":"us-ny"},{"user":"hen-123"}],"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["items"]},"cartItemInput":{"type":"object","properties":{"link":{"type":"string","format":"uri","description":"Direct product URL","example":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"},"quantity":{"description":"Quantity of this item","example":1,"default":1,"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"selectedOptions":{"description":"An ordered array of option values to select for the product. Will be selected in the order listed.","example":["regular","black","10-w"],"type":"array","items":{"type":"string"}},"selectedShipping":{"description":"Shipping option selected for this cart item","example":{"value":"standard"},"type":"object","properties":{"id":{"description":"Merchant-specific internal ID for the shipping option","example":"SHIP_EXPRESS","type":"string"},"value":{"description":"Common value of the shipping option","example":"express","type":"string"}}},"coupons":{"description":"List of coupon codes applied to this cart item","example":["SUMMER26","SAVE10"],"type":"array","items":{"type":"string"}},"metadata":{"description":"Misc metadata associated with this cart item","example":{"creatorSource":"Frank Herbert"},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["link"]},"cartSettings":{"type":"object","properties":{"options":{"type":"object","properties":{"allowPartialPurchase":{"description":"Whether the buyer can remove items from the cart during checkout","type":"boolean"},"collectBuyerEmail":{"description":"Controls email collection at checkout","example":"required","type":"string","enum":["off","required","optional"]},"collectBuyerAddress":{"description":"Controls address collection at checkout","example":"optional","type":"string","enum":["off","required","optional"]},"collectBuyerPhone":{"description":"Controls phone collection at checkout","example":"off","type":"string","enum":["off","required","optional"]}}},"commissionFeeFixed":{"type":"object","properties":{"value":{"type":"number","minimum":0,"description":"Fixed commission amount","example":1.99},"currency":{"default":"USD","description":"ISO-4217 currency code","example":"USD","type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value"]},"commissionFeePercent":{"description":"Commission percentage (0–100)","example":10,"type":"number","minimum":0,"maximum":100},"events":{"$ref":"#/components/schemas/cartTriggerEvents"}}},"cartTriggerEvents":{"description":"List of events to trigger during checkout","type":"array","items":{"$ref":"#/components/schemas/TriggerEvent"}},"TriggerEvent":{"type":"object","properties":{"type":{"type":"string","enum":["order","order.item","order.item.pending","order.item.processing","order.item.complete","order.item.failed","order.purchase","order.purchase.pending","order.purchase.processing","order.purchase.complete","order.purchase.cancelled","order.purchase.full","order.purchase.full.pending","order.purchase.full.processing","order.purchase.full.complete","order.purchase.full.cancelled","order.purchase.partial","order.purchase.partial.pending","order.purchase.partial.processing","order.purchase.partial.complete","order.purchase.partial.cancelled","order.update","order.update.3ds-required","order.update.adding-to-cart","order.update.filling-address-details","order.update.filling-card-details","order.update.submitting-order","order.update.changing-quantity","order.update.applying-coupon","order.update.selecting-shipping","order.update.selecting-options","points","points.give","points.remove","tier","tier.give","tier.remove"]},"conditional":{"$ref":"#/components/schemas/TriggerConditional"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}},"required":["type","data"]},"TriggerConditional":{"oneOf":[{"$ref":"#/components/schemas/TriggerConditionalTier"},{"$ref":"#/components/schemas/TriggerConditionalPoints"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"tier":"#/components/schemas/TriggerConditionalTier","points":"#/components/schemas/TriggerConditionalPoints"}}},"TriggerConditionalTier":{"type":"object","properties":{"type":{"type":"string","const":"tier"},"operator":{"type":"string","enum":["equals","not_equals"]},"value":{"type":"string"}},"required":["type","operator","value"]},"TriggerConditionalPoints":{"type":"object","properties":{"type":{"type":"string","const":"points"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal"]},"value":{"type":"number"}},"required":["type","operator","value"]},"Trigger":{"oneOf":[{"$ref":"#/components/schemas/TriggerGivePointsFixed"},{"$ref":"#/components/schemas/TriggerGivePointsPerSpent"},{"$ref":"#/components/schemas/TriggerRemovePointsFixed"},{"$ref":"#/components/schemas/TriggerRemovePointsPerSpent"},{"$ref":"#/components/schemas/TriggerGiveTier"},{"$ref":"#/components/schemas/TriggerRemoveTier"},{"$ref":"#/components/schemas/TriggerSendWebhook"},{"$ref":"#/components/schemas/TriggerSendEmail"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"give_points_fixed":"#/components/schemas/TriggerGivePointsFixed","give_points_per_spent":"#/components/schemas/TriggerGivePointsPerSpent","remove_points_fixed":"#/components/schemas/TriggerRemovePointsFixed","remove_points_per_spent":"#/components/schemas/TriggerRemovePointsPerSpent","give_tier":"#/components/schemas/TriggerGiveTier","remove_tier":"#/components/schemas/TriggerRemoveTier","send_webhook":"#/components/schemas/TriggerSendWebhook","send_email":"#/components/schemas/TriggerSendEmail"}}},"TriggerGivePointsFixed":{"type":"object","properties":{"type":{"type":"string","const":"give_points_fixed"},"points":{"type":"number"}},"required":["type","points"]},"TriggerGivePointsPerSpent":{"type":"object","properties":{"type":{"type":"string","const":"give_points_per_spent"},"points":{"type":"number"},"perAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"]}},"required":["type","points","perAmount"]},"TriggerRemovePointsFixed":{"type":"object","properties":{"type":{"type":"string","const":"remove_points_fixed"},"points":{"type":"number"}},"required":["type","points"]},"TriggerRemovePointsPerSpent":{"type":"object","properties":{"type":{"type":"string","const":"remove_points_per_spent"},"points":{"type":"number"},"perAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"]}},"required":["type","points","perAmount"]},"TriggerGiveTier":{"type":"object","properties":{"type":{"type":"string","const":"give_tier"},"tierUUID":{"type":"string"}},"required":["type","tierUUID"]},"TriggerRemoveTier":{"type":"object","properties":{"type":{"type":"string","const":"remove_tier"}},"required":["type"]},"TriggerSendWebhook":{"type":"object","properties":{"type":{"type":"string","const":"send_webhook"},"webhookUUID":{"type":"string"}},"required":["type","webhookUUID"]},"TriggerSendEmail":{"type":"object","properties":{"type":{"type":"string","const":"send_email"}},"required":["type"]},"cartAddItemInput":{"type":"object","properties":{"item":{"description":"Item to add to the cart (can be object or stringified JSON)","$ref":"#/components/schemas/cartItemInput"}},"required":["item"]},"cartDetailsInput":{"type":"object","properties":{"mode":{"description":"Response mode. Use sync to wait up to 30 seconds for the backing worker flow to complete.","example":"async","type":"string","enum":["async","sync"]},"buyer":{"type":"object","properties":{"shippingAddress":{"type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"]},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"province":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}},"required":["line1","city","province","postalCode","countryCode"],"description":"Shipping address for the cart"}},"required":["shippingAddress"]},"coupons":{"description":"List of coupon codes applied to the cart","example":["SUMMER21","FREESHIP"],"type":"array","items":{"type":"string"}},"metadata":{"description":"Additional metadata for the request","type":"object","properties":{"botAuth":{"description":"Bot authentication credentials","type":"object","properties":{"forterToken":{"description":"Forter token for bot authentication","type":"string"}}},"userData":{"description":"User identity and device information","type":"object","properties":{"ipAddress":{"description":"IP address of the user","type":"string"},"userAgent":{"description":"User agent string of the user's browser or client","type":"string"}}}}}},"required":["buyer"]},"cartPurchaseInput":{"type":"object","properties":{"mode":{"description":"Response mode. Use sync to wait up to 30 seconds for the backing worker flow to complete.","example":"async","type":"string","enum":["async","sync"]},"overrideProducts":{"type":"object","propertyNames":{"type":"string","format":"uri"},"additionalProperties":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":"Override quantity for a specific product URL"},"buyer":{"type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"description":"Buyer's full name","example":{"firstName":"John","middleName":"A.","lastName":"Doe"}},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"Buyer's email address","example":"henry@example.com"},"phone":{"description":"Buyer's phone number","example":"+1234567890","type":"string"},"shippingAddress":{"type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"]},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"province":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}},"required":["line1","city","province","postalCode","countryCode"],"description":"Shipping address for the cart"},"card":{"type":"object","properties":{"nameOnCard":{"description":"Name on the payment card","example":{"firstName":"John","middleName":"A.","lastName":"Doe"},"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"details":{"type":"object","properties":{"cardToken":{"type":"string","description":"Tokenized card token for payment","example":"card_live_SimDpKU9cmU7tvdUXHzOeLudtgfadQVnbof"}},"required":["cardToken"],"description":"Card details for payment"},"billingAddress":{"description":"Billing address for the card (optional if same as shipping)","type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"]},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"province":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}},"required":["line1","city","province","postalCode","countryCode"]}},"required":["details"]}},"required":["name","email","shippingAddress","card"]},"settings":{"description":"Settings for what information to collect","type":"object","properties":{"collectEmail":{"description":"Whether to collect the buyer's email address","type":"boolean"},"collectAddress":{"description":"Whether to collect the buyer's shipping address","type":"boolean"},"collectPhone":{"description":"Whether to collect the buyer's phone number","type":"boolean"}}},"metadata":{"description":"Additional metadata for the request","type":"object","properties":{"botAuth":{"description":"Bot authentication credentials","type":"object","properties":{"forterToken":{"description":"Forter token for bot authentication","type":"string"}}},"userData":{"description":"User identity and device information","type":"object","properties":{"ipAddress":{"description":"IP address of the user","type":"string"},"userAgent":{"description":"User agent string of the user's browser or client","type":"string"}}}}}},"required":["buyer"]},"productDetailsInput":{"type":"object","properties":{"mode":{"description":"Response mode. Use sync to wait up to 30 seconds for the backing worker flow to complete.","example":"async","type":"string","enum":["async","sync"]},"link":{"type":"string","format":"uri","description":"Direct product URL","example":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"},"selectedOptions":{"description":"An ordered array of option values to select for the product. Will be selected in the order listed.","example":["regular","black","10-w"],"type":"array","items":{"type":"string"}},"country":{"description":"Country code for the product's location","example":"US","type":"string"}},"required":["link"]},"productSearchStatusResponse":{"type":"object","properties":{"refId":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$"},"status":{"type":"string","enum":["pending","processing","complete","failed"]},"result":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/productSearchResponseData"}},"pagination":{"type":"object","properties":{"nextCursor":{"anyOf":[{"type":"number"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["nextCursor","previousCursor"],"additionalProperties":false}},"required":["products","pagination"],"additionalProperties":false},"error":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["refId","status"],"additionalProperties":false},"productSearchResponseData":{"type":"object","properties":{"link":{"type":"string","format":"uri"},"merchant":{"type":"string"},"host":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"isFeatured":{"type":"boolean"},"url":{"type":"string"}},"required":["url"],"additionalProperties":false}},"price":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"originalPrice":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"availability":{"type":"string","enum":["in_stock","limited_stock","out_of_stock","preorder","backorder"]},"options":{"$ref":"#/components/schemas/__schema0"}},"required":["link","merchant","host","name"],"additionalProperties":false},"cartCreateResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/cartCreateResponseData"}},"required":["success","status","message","data"],"additionalProperties":false},"cartCreateResponseData":{"type":"object","properties":{"cartId":{"type":"string","description":"ID for the created cart"},"checkoutUrl":{"type":"string","format":"uri","description":"URL for the buyer to make their purchase"},"data":{"$ref":"#/components/schemas/cartCreateInputOutput"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["cartId","checkoutUrl","data"],"additionalProperties":false},"cartFetchResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/cartCreateResponseData"}}},"required":["success","status","message","data"],"additionalProperties":false},"cartDetailsStatusResponse":{"type":"object","properties":{"refId":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$"},"status":{"type":"string","enum":["pending","processing","complete","failed"]},"result":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"shippingOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"cost":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"timeEstimate":{"type":"string"},"minDate":{"type":"string"},"maxDate":{"type":"string"}},"required":["id","name","cost"],"additionalProperties":false}},"costs":{"type":"object","properties":{"subtotal":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"tax":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"shipping":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"discount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"total":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["subtotal","total"],"additionalProperties":false},"coupons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"available":{"type":"boolean"},"savedAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["code","available"],"additionalProperties":false}}},"required":["shippingOptions","costs"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false},"error":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["refId","status"],"additionalProperties":false},"cartDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/cartDetailsStatusResponse"},"description":"List of jobs created to fetch checkout details for each cart item"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["jobs"],"additionalProperties":false}},"required":["success","status","message","data"],"additionalProperties":false},"cartPurchaseStatusResponse":{"type":"object","properties":{"refId":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$"},"status":{"type":"string","enum":["pending","processing","complete","cancelled"]},"products":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","processing","complete","failed"]},"link":{"type":"string","format":"uri"},"quantity":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"merchant":{"type":"string"},"host":{"type":"string"},"selectedOptions":{"type":"array","items":{"type":"string"}},"selectedShipping":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"required":["status","link","quantity","merchant","host"],"additionalProperties":false}},"details":{"type":"object","properties":{"hasAccount":{"type":"boolean"},"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"additionalProperties":false},"email":{"type":"string"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"],"additionalProperties":false},"shippingAddress":{"type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"additionalProperties":false},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"],"additionalProperties":false},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"province":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}},"required":["line1","city","province","postalCode","countryCode"],"additionalProperties":false},"card":{"type":"object","properties":{"nameOnCard":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"additionalProperties":false},"details":{"type":"object","properties":{},"additionalProperties":false},"billingAddress":{"type":"object","properties":{"name":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"additionalProperties":false},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"nationalNumber":{"type":"string"},"e164":{"type":"string"},"country":{"type":"string"}},"required":["countryCode","nationalNumber","e164"],"additionalProperties":false},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"province":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}},"required":["line1","city","province","postalCode","countryCode"],"additionalProperties":false}},"required":["nameOnCard","details"],"additionalProperties":false},"settings":{"type":"object","properties":{"collectEmail":{"type":"boolean"},"collectAddress":{"type":"boolean"},"collectPhone":{"type":"boolean"}},"additionalProperties":false}},"required":["hasAccount","name","card"],"additionalProperties":false},"result":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"productLink":{"type":"string","format":"uri"},"confirmationNumber":{"type":"string"},"shipping":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"cost":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"timeEstimate":{"type":"string"},"minDate":{"type":"string"},"maxDate":{"type":"string"}},"required":["id","name","cost"],"additionalProperties":false},"costs":{"type":"object","properties":{"subtotal":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"tax":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"shipping":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"discount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"total":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["total"],"additionalProperties":false},"appliedCoupon":{"type":"object","properties":{"code":{"type":"string"},"savedAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["code"],"additionalProperties":false},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["productLink","confirmationNumber","costs"],"additionalProperties":false}},"costs":{"type":"object","properties":{"subtotal":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"commissionFee":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"total":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["subtotal","commissionFee","total"],"additionalProperties":false}},"required":["items","costs"],"additionalProperties":false},"error":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["refId","status","products","details"],"additionalProperties":false},"merchantsFetchResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/merchantData"}}},"required":["success","status","message","data"],"additionalProperties":false},"merchantData":{"type":"object","properties":{"host":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"website":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["landing","checkout"]}},"required":["value"],"additionalProperties":false}}},"required":["urls"],"additionalProperties":false},"logo":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false}}},"required":["urls"],"additionalProperties":false},"categories":{"type":"array","items":{"type":"string","enum":["automotive","baby_and_kids","ecommerce","electronics_and_gadgets","fashion_and_accessories","finance","food","health_and_beauty","home_and_living","lifestyle_and_entertainment","other","sports_and_outdoor","travel","education"]}}},"required":["host","name","description","website","logo","categories"],"additionalProperties":false},"ordersFetchResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/cartPurchaseStatusResponse"}}},"required":["success","status","message","data"],"additionalProperties":false},"productDetailsStatusResponse":{"type":"object","properties":{"refId":{"type":"string","pattern":"^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$"},"status":{"type":"string","enum":["pending","processing","complete","failed"]},"result":{"$ref":"#/components/schemas/productDetailsResponseData"},"error":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["refId","status"],"additionalProperties":false},"productDetailsResponseData":{"type":"object","properties":{"link":{"type":"string","format":"uri"},"merchant":{"type":"string"},"host":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"isFeatured":{"type":"boolean"},"url":{"type":"string"}},"required":["url"],"additionalProperties":false}},"price":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"originalPrice":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"availability":{"type":"string","enum":["in_stock","limited_stock","out_of_stock","preorder","backorder"]},"options":{"$ref":"#/components/schemas/__schema0"}},"required":["link","merchant","host","name"],"additionalProperties":false},"__schema0":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","const":"found"},"label":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"availability":{"type":"string","enum":["in_stock","limited_stock","out_of_stock","preorder","backorder"]},"images":{"type":"array","items":{"type":"object","properties":{"isFeatured":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":false}},"link":{"type":"string"},"nextOption":{"$ref":"#/components/schemas/__schema0"}},"required":["value"],"additionalProperties":false}}},"required":["status","values"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"unknown"},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}]},"cartCreateInputOutput":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/cartItemInputOutput"},"description":"Items to include in the cart"},"settings":{"$ref":"#/components/schemas/cartSettingsOutput"},"tags":{"description":"Key-value tags to associate with the cart","examples":[{"region":"us-ny"},{"user":"hen-123"}],"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["items"],"additionalProperties":false},"cartItemInputOutput":{"type":"object","properties":{"link":{"type":"string","format":"uri","description":"Direct product URL","example":"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"},"quantity":{"description":"Quantity of this item","example":1,"default":1,"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"selectedOptions":{"description":"An ordered array of option values to select for the product. Will be selected in the order listed.","example":["regular","black","10-w"],"type":"array","items":{"type":"string"}},"selectedShipping":{"description":"Shipping option selected for this cart item","example":{"value":"standard"},"type":"object","properties":{"id":{"description":"Merchant-specific internal ID for the shipping option","example":"SHIP_EXPRESS","type":"string"},"value":{"description":"Common value of the shipping option","example":"express","type":"string"}},"additionalProperties":false},"coupons":{"description":"List of coupon codes applied to this cart item","example":["SUMMER26","SAVE10"],"type":"array","items":{"type":"string"}},"metadata":{"description":"Misc metadata associated with this cart item","example":{"creatorSource":"Frank Herbert"},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["link"],"additionalProperties":false},"cartSettingsOutput":{"type":"object","properties":{"options":{"type":"object","properties":{"allowPartialPurchase":{"description":"Whether the buyer can remove items from the cart during checkout","type":"boolean"},"collectBuyerEmail":{"description":"Controls email collection at checkout","example":"required","type":"string","enum":["off","required","optional"]},"collectBuyerAddress":{"description":"Controls address collection at checkout","example":"optional","type":"string","enum":["off","required","optional"]},"collectBuyerPhone":{"description":"Controls phone collection at checkout","example":"off","type":"string","enum":["off","required","optional"]}},"additionalProperties":false},"commissionFeeFixed":{"type":"object","properties":{"value":{"type":"number","minimum":0,"description":"Fixed commission amount","example":1.99},"currency":{"default":"USD","description":"ISO-4217 currency code","example":"USD","type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false},"commissionFeePercent":{"description":"Commission percentage (0–100)","example":10,"type":"number","minimum":0,"maximum":100},"events":{"$ref":"#/components/schemas/cartTriggerEventsOutput"}},"additionalProperties":false},"cartTriggerEventsOutput":{"description":"List of events to trigger during checkout","type":"array","items":{"$ref":"#/components/schemas/TriggerEventOutput"}},"TriggerEventOutput":{"type":"object","properties":{"type":{"type":"string","enum":["order","order.item","order.item.pending","order.item.processing","order.item.complete","order.item.failed","order.purchase","order.purchase.pending","order.purchase.processing","order.purchase.complete","order.purchase.cancelled","order.purchase.full","order.purchase.full.pending","order.purchase.full.processing","order.purchase.full.complete","order.purchase.full.cancelled","order.purchase.partial","order.purchase.partial.pending","order.purchase.partial.processing","order.purchase.partial.complete","order.purchase.partial.cancelled","order.update","order.update.3ds-required","order.update.adding-to-cart","order.update.filling-address-details","order.update.filling-card-details","order.update.submitting-order","order.update.changing-quantity","order.update.applying-coupon","order.update.selecting-shipping","order.update.selecting-options","points","points.give","points.remove","tier","tier.give","tier.remove"]},"conditional":{"$ref":"#/components/schemas/TriggerConditionalOutput"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TriggerOutput"}}},"required":["type","data"],"additionalProperties":false},"TriggerConditionalOutput":{"oneOf":[{"$ref":"#/components/schemas/TriggerConditionalTierOutput"},{"$ref":"#/components/schemas/TriggerConditionalPointsOutput"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"tier":"#/components/schemas/TriggerConditionalTierOutput","points":"#/components/schemas/TriggerConditionalPointsOutput"}}},"TriggerConditionalTierOutput":{"type":"object","properties":{"type":{"type":"string","const":"tier"},"operator":{"type":"string","enum":["equals","not_equals"]},"value":{"type":"string"}},"required":["type","operator","value"],"additionalProperties":false},"TriggerConditionalPointsOutput":{"type":"object","properties":{"type":{"type":"string","const":"points"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal"]},"value":{"type":"number"}},"required":["type","operator","value"],"additionalProperties":false},"TriggerOutput":{"oneOf":[{"$ref":"#/components/schemas/TriggerGivePointsFixedOutput"},{"$ref":"#/components/schemas/TriggerGivePointsPerSpentOutput"},{"$ref":"#/components/schemas/TriggerRemovePointsFixedOutput"},{"$ref":"#/components/schemas/TriggerRemovePointsPerSpentOutput"},{"$ref":"#/components/schemas/TriggerGiveTierOutput"},{"$ref":"#/components/schemas/TriggerRemoveTierOutput"},{"$ref":"#/components/schemas/TriggerSendWebhookOutput"},{"$ref":"#/components/schemas/TriggerSendEmailOutput"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"give_points_fixed":"#/components/schemas/TriggerGivePointsFixedOutput","give_points_per_spent":"#/components/schemas/TriggerGivePointsPerSpentOutput","remove_points_fixed":"#/components/schemas/TriggerRemovePointsFixedOutput","remove_points_per_spent":"#/components/schemas/TriggerRemovePointsPerSpentOutput","give_tier":"#/components/schemas/TriggerGiveTierOutput","remove_tier":"#/components/schemas/TriggerRemoveTierOutput","send_webhook":"#/components/schemas/TriggerSendWebhookOutput","send_email":"#/components/schemas/TriggerSendEmailOutput"}}},"TriggerGivePointsFixedOutput":{"type":"object","properties":{"type":{"type":"string","const":"give_points_fixed"},"points":{"type":"number"}},"required":["type","points"],"additionalProperties":false},"TriggerGivePointsPerSpentOutput":{"type":"object","properties":{"type":{"type":"string","const":"give_points_per_spent"},"points":{"type":"number"},"perAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["type","points","perAmount"],"additionalProperties":false},"TriggerRemovePointsFixedOutput":{"type":"object","properties":{"type":{"type":"string","const":"remove_points_fixed"},"points":{"type":"number"}},"required":["type","points"],"additionalProperties":false},"TriggerRemovePointsPerSpentOutput":{"type":"object","properties":{"type":{"type":"string","const":"remove_points_per_spent"},"points":{"type":"number"},"perAmount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string","enum":["USD","EUR","AUD","SGD","TWD","GBP","CAD","MXN","NPR"]}},"required":["value","currency"],"additionalProperties":false}},"required":["type","points","perAmount"],"additionalProperties":false},"TriggerGiveTierOutput":{"type":"object","properties":{"type":{"type":"string","const":"give_tier"},"tierUUID":{"type":"string"}},"required":["type","tierUUID"],"additionalProperties":false},"TriggerRemoveTierOutput":{"type":"object","properties":{"type":{"type":"string","const":"remove_tier"}},"required":["type"],"additionalProperties":false},"TriggerSendWebhookOutput":{"type":"object","properties":{"type":{"type":"string","const":"send_webhook"},"webhookUUID":{"type":"string"}},"required":["type","webhookUUID"],"additionalProperties":false},"TriggerSendEmailOutput":{"type":"object","properties":{"type":{"type":"string","const":"send_email"}},"required":["type"],"additionalProperties":false}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"},"AccessTokenAuth":{"type":"apiKey","in":"header","name":"x-access-token","description":"Supabase access token for authentication."}}}}