> ## Documentation Index > Fetch the complete documentation index at: https://docs.snappy.com/llms.txt > Use this file to discover all available pages before exploring further. # Autocomplete order address > Use this endpoint to retrieve address suggestions based on a partial input string. Use this when you're building an address input field in your platform UI - autocomplete reduces typos and helps end users land on complete, deliverable addresses before order placement. **Required parameters** - `address` query parameter - partial address text from the user. 4-128 characters. - `country` query parameter - country code to scope the suggestions to. 2-3 characters. **Optional parameters** - `companyId` query parameter - Company identifier, when not inferable from the API key context (8+ alphanumeric characters) ###### Please note - Returns an array of suggestions in the `results` field. Each entry follows the standard address shape (`addressLine1`, `addressLine2`, `city`, `state`, `zipcode`). - The `address` parameter is free text and the endpoint may be called frequently as the user types. **Debounce input by 200-300ms** before issuing the request to avoid excessive calls and stay within rate limits. - This endpoint is a UI helper - it suggests addresses but does **not** validate deliverability. Pair it with `POST /v2/orders/addresses/validate` before placing an order if you need verified-deliverable addresses. #### Permissions - Requires: `orders:read:masked` or `orders:read:unmasked` ## OpenAPI ````yaml get /v2/orders/addresses/autocomplete openapi: 3.0.0 info: title: Snappy Public API version: 2.0.0 contact: name: Snappy Support email: info@snappy.com description: >- Welcome to the Snappy API reference documentation! You can use this API to integrate with Snappy and spread smiles to your employees/clients/customers and much more. In just 3 simple steps you can start sending gifts today: pull the relevant campaign, send gifts to your recipients and track gift statuses. So let's get started! servers: - url: https://api.snappy.com/public-api description: Base API URL - url: https://mtls-api.snappy.com/public-api description: >- ## mTLS URL You can also use mTLS to enhance your API security. To get your specific certificates please contact our support. Once you configure the certificated correctly, you need to also update endpoints to use the following secure api base URL: security: [] tags: - name: Authentication description: >- API keys authenticate requests to the Snappy API. Use these endpoints to list active keys for your Company, create new keys, or delete keys you no longer need. - name: Accounts description: >- An **Account** is a sub-entity that lives within a **Company**. Accounts are used to separate and organize your company's campaigns and gift sends for different teams, departments or budget owners. - name: Campaigns description: >- A **Campaign** is the primary organizational object used to configure and send a batch of gifts. It acts as a template for all the settings of a single gifting initiative, including the target **Recipient** list, the selected **Collection** or **product**, the budget, branding, and notification messages. - name: Collections description: >- A **Collection** is a curated catalog of gift items tailored to a specific theme, budget range, and audience (e.g., "Birthday Gifts Under $50"). The gift recipient then chooses their preferred item directly from this collection. Use these endpoints to: - Get available collections based on budget and country requirements - Retrieve budget ranges for specific collections - Access collection details and products Please note: Swag collections can only be retrieved by specifying the accountId in the request. - name: Products & Variants description: >- Use these endpoints to search for and retrieve products and variants (including by collection and budget), and to list product tags for building catalog and filtering experiences in your UI. - name: Gifts description: >- A **Gift** is the core transactional object in the Snappy system. It represents the entire gifting experience for a **Recipient** within a **Campaign**, from initial creation to final delivery. The **Gift** object tracks the status and details through each stage of its lifecycle: 1. **Creation:** The gift is initiated and associated with a recipient and campaign. 2. **Notification:** The recipient is notified about their gift via email or other channels. 3. **Selection:** The recipient selects a specific product from the gift collection (if applicable). 4. **Order Generation:** An order is created based on the selected product and the recipient's shipping address. 5. **Delivery:** The physical product is shipped and its delivery status is tracked to completion. - name: Orders description: >- Endpoints for programmatically claiming gifts (ordering on behalf of recipients), cancelling orders before they ship, and validating or autocompleting shipping addresses as part of your checkout or fulfillment flow. - name: Recipients description: A **Recipient** is the end-user who receives a **Gift**. paths: /v2/orders/addresses/autocomplete: get: tags: - Orders summary: Autocomplete order address description: >- Use this endpoint to retrieve address suggestions based on a partial input string. Use this when you're building an address input field in your platform UI - autocomplete reduces typos and helps end users land on complete, deliverable addresses before order placement. **Required parameters** - `address` query parameter - partial address text from the user. 4-128 characters. - `country` query parameter - country code to scope the suggestions to. 2-3 characters. **Optional parameters** - `companyId` query parameter - Company identifier, when not inferable from the API key context (8+ alphanumeric characters) ###### Please note - Returns an array of suggestions in the `results` field. Each entry follows the standard address shape (`addressLine1`, `addressLine2`, `city`, `state`, `zipcode`). - The `address` parameter is free text and the endpoint may be called frequently as the user types. **Debounce input by 200-300ms** before issuing the request to avoid excessive calls and stay within rate limits. - This endpoint is a UI helper - it suggests addresses but does **not** validate deliverability. Pair it with `POST /v2/orders/addresses/validate` before placing an order if you need verified-deliverable addresses. #### Permissions - Requires: `orders:read:masked` or `orders:read:unmasked` operationId: autocompleteOrderAddress parameters: - schema: type: string pattern: ^[A-Za-z0-9]{8,}$ description: Company ID example: '12345678' required: false description: Company ID name: companyId in: query - schema: type: string minLength: 4 maxLength: 128 description: Address example: 123 Main St required: true description: Address name: address in: query - schema: type: string pattern: ^[A-Za-z0-9]{2,3}$ description: Country example: US required: true description: Country name: country in: query responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/AutocompleteOrderAddressResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiStringError' '401': description: Unauthorized content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiStringError' - example: status: 401 errorCode: 401_PBLC_001 message: Unauthorized '422': description: Unprocessable Entity content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiStringError' - example: status: 422 errorCode: 422_PBLC_001 message: Unprocessable Entity security: - CompanyLevelAuthentication: [] - BearerAuthentication: [] components: schemas: AutocompleteOrderAddressResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/OrderRecipientAddress' description: The autocomplete address results. required: - results additionalProperties: false description: Autocomplete order address response. ApiStringError: type: object properties: status: type: integer description: The HTTP status code. example: 400 errorCode: type: string description: >- Internal error code, helps Snappy's technical team to troubleshoot if needed. example: 400_PBLC_001 message: type: string description: The error message. example: Unauthorized errors: type: array items: type: object properties: path: type: string description: The path of the field that caused the error. example: body.recipients.0.email message: type: string description: The error message. example: Invalid email. errorCode: type: string description: >- Internal error code, helps Snappy's technical team to troubleshoot if needed. example: 400_PBLC_002 required: - path - message - errorCode description: >- An array of client errors. This field is being returned only for errors the client should fix, usually with status code 400. required: - status - errorCode - message description: >- API error response with string error codes and optional client error details example: status: 400 errorCode: 400_PBLC_001 message: Bad Request OrderRecipientAddress: type: object properties: addressLine1: type: string description: Delivery address line 1 example: 123 Main St addressLine2: type: string description: Delivery address line 2 example: Apt 1 zipcode: type: string pattern: ^[a-zA-Z0-9 -]{3,10}$ description: Delivery address zip code example: '12345' city: type: string description: Delivery address city example: New York state: type: string pattern: ^[A-Z]{1,3}$ description: >- Delivery address region code: typically 2 letters (for example US state), or up to 3 letters where required (for example Australian states and territories) example: NY description: Delivery address details. securitySchemes: CompanyLevelAuthentication: type: apiKey in: header name: X-Api-Key description: > ## Company Level Authentication Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients. ### Getting Your API Key 1. **Create an API Key**: Use the `POST /v2/authentication/apiKeys` endpoint to generate a new API key 2. **Set Expiration**: Choose from 30, 60, 90, or 180 days (default: 90 days) 3. **Optional mTLS**: Enable mutual TLS for enhanced security 4. **Name Your Key**: Provide a descriptive name for easy identification ### Using Your API Key Include your API key in the `X-Api-Key` header for every request: ``` X-Api-Key: YOUR_24_CHARACTER_API_KEY ``` ### API Key Management - **Maximum Keys**: Up to 3 active API keys per company - **Rotation**: Delete old keys before creating new ones when at the limit - **Security**: Keys are hashed and cannot be retrieved after creation ### Enhanced Security (mTLS) For production environments, enable mutual TLS authentication: 1. Set `enforceMtls: true` when creating the API key 2. Contact support to obtain your client certificates 3. Use the mTLS endpoint: `https://mtls-api.snappy.com/public-api` BearerAuthentication: type: http scheme: bearer bearerFormat: JWT description: >- Bearer authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients. ````