> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/checkout-api/resources/sales-assisted-checkout-tracking.md). # Sales Assisted Checkout Tracking When checkouts are manually created by sales assistants for shoppers, ESW’s Sales Assisted Checkout Tracking feature identifies which sales assistant assisted the shopper. This lets you track assisted sales and the sales assistants who drove them. There are mandatory and optional parameters you need to send to ESW to use this feature. ## Mandatory Parameters ### Sales Assistant ID When a sale has been assisted by a sales assistant, send metadata with these parameters: 1. `SA_ID`: The ID associated with a sales assistant. 2. `Order_Channel`: Tracks the channel where the assistance occurred. You decide and create these values as the retailer. ESW consumes the values you send. Add these metadata parameters to the `shopperCheckoutExperience` object in the preorder. When the checkout loads, `SA_ID` and `Order_Channel` are persisted and sent back to you in the order request. Metadata: * `name`: `SA_ID` * `value`: `` * `name`: `Order_Channel` * `value`: `` ## Optional Parameters ### User Registration You can also tell ESW whether the shopper is not registered with you and should be registered before continuing to checkout. This registration step may have been skipped by the sales representative before the checkout loads. If you want the user to register with you, you must tell ESW that registration is expected. To support this, send metadata with: 1. `Registration_Needed`: A boolean flag that shows whether registration is required. 2. `Registration_URL`: The redirect URL for the retailer-owned registration page. Add these metadata parameters to the `shopperCheckoutExperience` object in the preorder. Metadata: * `name`: `Registration_Needed` * `value`: `` * `name`: `Registration_URL` * `value`: `` Notes: * The user registration sub-feature can be enabled independently of sales assistant tracking. * The user registration text can be updated to suit the retailer. ### Extended Session Expiry You can also extend the session length for sales-assistant-tracked orders. Set the session timeout in the preorder request to any value between `5` and `90` minutes. The URLs manually sent to the shopper will then use the extended session period. To support this, the preorder must contain `SA_ID`, `Order_Channel`, and a `sessionTimeout` value. * If no `sessionTimeout` value is provided, the default timeout is `15` minutes. * All other sessions remain valid for the default session time. * This applies to `Checkout v2` and `Checkout v3`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developer.esw.com/checkout-api/resources/sales-assisted-checkout-tracking.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.