> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/partner-api-overview/onboarding-checklist.md).

# Onboarding Checklist

## Prerequisites & Access Setup

### Required Access

| Task                                                                                                                                                                         | Status |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| Namespace access is managed at the team level. To request access, provide the namespace and environment details (for example, `EU3_retailerco`) to the Epsilon Support team. | ☐      |
| Ensure you have membership in the correct supplier or primary retailer team. Access to the appropriate team is required to generate the API token.                           | ☐      |
| API intake request submitted (KB0040933).                                                                                                                                    | ☐      |
| Reporting API (BigQuery) access requested if needed.                                                                                                                         | ☐      |
| User Key retrieved from profile settings.                                                                                                                                    | ☐      |
| Base URL obtained from Support team.                                                                                                                                         | ☐      |

### Environment Setup

| Task                                                                                                                                                                                                                               | Status |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| <p>Sandbox environment API URL confirmed.<br>(Contact the Service Desk to confirm the correct sandbox domain for your account).</p>                                                                                                | ☐      |
| <p>Environment URLs confirmed.<br>(Contact the Service Desk to confirm the correct environment domain for your account).</p>                                                                                                       | ☐      |
| <p>Required metadata (product catalog, placement, team information) is verified by either:<br><br>- Raising a ticket with the Service Desk, or<br>- Accessing BigQuery tables: dim\_product, dim\_catalog, and dim\_placement.</p> | ☐      |

## Authentication & Core Integration

### Authentication Setup

| Task                                             | Status |
| ------------------------------------------------ | ------ |
| User Key Authentication token implemented.       | ☐      |
| Access token retrieval working (24-hour expiry). | ☐      |
| Authentication headers configured correctly.     | ☐      |
| Sandbox authentication tested.                   | ☐      |

### Core API Integration

| Task                                         | Status |
| -------------------------------------------- | ------ |
| Campaign Management endpoints integrated.    | ☐      |
| Team & User Management endpoints integrated. | ☐      |
| Wallet Management endpoints integrated.      | ☐      |
| Content Standard endpoints integrated.       | ☐      |
| Bulk Operation API endpoints configured.     | ☐      |

### Data Format Validation

| Task                                                                    | Status |
| ----------------------------------------------------------------------- | ------ |
| JSON payload structures validated.                                      | ☐      |
| Required field mappings completed.                                      | ☐      |
| Campaign field definitions understood.                                  | ☐      |
| Creative asset requirements verified (< 4MB, PNG/JPEG/JPG/GIF/SVG/PDF). | ☐      |
| ISO-8601 timestamp format implemented.                                  | ☐      |

## Campaign & Feature Testing

### Campaign Testing

| Task                                                                                                            | Status |
| --------------------------------------------------------------------------------------------------------------- | ------ |
| Sponsored Product Ads (SPA) creation tested.                                                                    | ☐      |
| Banner campaign creation tested.                                                                                | ☐      |
| Banner X campaign creation tested.                                                                              | ☐      |
| Campaign approval state changes tested (required only for Retailer integrations; not applicable for Suppliers). | ☐      |
| Bulk campaign operations tested (optional, based on the use case).                                              | ☐      |

### Wallet & Team Testing

| Task                                      | Status |
| ----------------------------------------- | ------ |
| Wallet creation and management tested.    | ☐      |
| Fund management operations tested.        | ☐      |
| Team creation and user invitation tested. | ☐      |
| User permission modifications tested.     | ☐      |
| Spend calculation endpoints tested.       | ☐      |

### File & Asset Testing

| Task                                     | Status |
| ---------------------------------------- | ------ |
| Creative asset uploads tested.           | ☐      |
| File size and format validation working. | ☐      |
| Content standard retrieval tested.       | ☐      |
| Logo uploads for teams/users tested.     | ☐      |

## Best Practices Implementation

| Task                                           | Status |
| ---------------------------------------------- | ------ |
| Bulk endpoints used for multiple operations.   | ☐      |
| Compressed files implemented for uploads.      | ☐      |
| Error handling with structured JSON responses. | ☐      |
| Field validation before request submission.    | ☐      |

## Monitoring & Support

| Task                                    | Status |
| --------------------------------------- | ------ |
| API call monitoring implemented.        | ☐      |
| Error logging and alerting configured.  | ☐      |
| Performance metrics tracking setup.     | ☐      |
| Support contact information documented. | ☐      |
| Escalation procedures established.      | ☐      |

## Requirements Checklist

### Must-Have Before Go-Live

| Task                                                                               | Status |
| ---------------------------------------------------------------------------------- | ------ |
| User Key Authentication working in production.                                     | ☐      |
| Campaign creation (SPA/Banner/Banner X) functional.                                | ☐      |
| Creative asset uploads working (< 4MB limit).                                      | ☐      |
| Error handling for all HTTP status codes.                                          | ☐      |
| Bulk operations tested for efficiency.                                             | ☐      |
| Content standards and placements validated (including PDF component verification). | ☐      |

### API-Specific Validations

| Task                                                    | Status |
| ------------------------------------------------------- | ------ |
| Namespace access confirmed.                             | ☐      |
| Team membership and permissions verified.               | ☐      |
| Required metadata (catalog, placement) available.       | ☐      |
| BigQuery access for reporting (if needed).              | ☐      |
| File format validation (PNG, JPEG, JPG, GIF, SVG, PDF). | ☐      |
| ISO-8601 timestamp format compliance.                   | ☐      |


---

# 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://help.citrusad.com/retail-media-interface/partner/partner-api-overview/onboarding-checklist.md?ask=<question>&goal=<endgoal>
```

`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.