> ## Documentation Index > Fetch the complete documentation index at: https://partner-help.letsdothis.com/llms.txt > Use this file to discover all available pages before exploring further. # Get add-on import status > Returns task counts and paginated per-product results for an organizer-owned add-on product import. Poll until the status is completed or cancelled. This endpoint is restricted and not generally available: organizations that have not been enabled receive a `403`. Contact your Let's Do This representative if you'd like access. ## OpenAPI ````yaml /openapi.json get /v0/add-ons/import/{jobId} openapi: 3.1.0 info: title: Let's Do This API version: 0.1.0 description: > The full reference — getting started, pagination, error responses, rate limits and the changelog — lives at [partner-help.letsdothis.com/api-reference](https://partner-help.letsdothis.com/api-reference/overview). This page is the interactive OpenAPI view of the same specification. # Authentication Create an API key from **Settings** → **Credentials** in your Let's Do This account and send it as a bearer token: ```bash curl --request GET \ --url "https://api.letsdothis.com/v0/participants" \ --header "Authorization: Bearer YOUR-API-KEY" ``` Keep the key secret: it identifies your organization, so do not ship it in a website or native app. If a key is exposed, revoke it from the same section and create a replacement. # OpenAPI schema Download the [OpenAPI schema](https://api.letsdothis.com/documentation/json) to use with Postman or an OpenAPI client generator. servers: - url: https://api.letsdothis.com description: Production - url: https://api.staging.letsdothis.com description: Staging security: - bearerAuth: [] tags: - name: Events x-group: Events description: Events that participants can register for. - name: EventOccurrences x-group: Event occurrences description: >- Event occurrences scoped to the organizer associated with your Public API credentials. Unlike the public Events catalog, results are limited to your own events. - name: Races x-group: Races description: >- Races within an event occurrence. An event occurrence may have one or more races, for example a 5K and a 10K within the same race day. - name: Tickets x-group: Tickets description: Tickets that are available for events. - name: BookingForms x-group: Booking forms description: >- Booking forms define the questions a booker answers when registering for a ticket. A ticket usually references a single booking form, so expect zero or one, while a booking form may be shared across multiple tickets. - name: BookingFormFields x-group: Booking form fields description: >- Booking form fields are the individual questions on a booking form — their type, label, options, and whether an answer is required. A field can be reused across multiple forms. - name: Bookings x-group: Bookings description: >- Bookings are the transaction record for a registration. A booking may contain one or more participants (entries). - name: Participant x-group: Participants description: Participants are users who successfully booked an event. - name: LineItem x-group: Line items description: Financial details related to individual items within transactions. - name: AddOns x-group: Add-ons description: >- Organizer-owned products that can be purchased and allocated to participants. Imported products retain stable external identities. - name: DiscountCodes x-group: Discount codes description: >- Discount codes participants enter at checkout to reduce the price of a booking. - name: Credits x-group: Credits description: >- Credits are balances participants can spend at checkout, identified by their email address. - name: Referrals x-group: Referrals description: >- Referral programs, the referrers registered on them, and asynchronous imports of historical referrals. - name: Application x-group: Applications description: >- Applications are created when a user applies for tickets that are set up to require an application process, such as balloted or "Good For Age" entries. - name: Partner x-group: Partners description: >- Partners that were created by the organization who can have Reserved Entries assigned to them. - name: ReservedEntries x-group: Reserved entries description: >- Reserved Entries are entries that are reserved for a partner. After being assigned, the partner can then allocate these entries to participants. - name: Timing x-group: Timing description: >- Timing providers push bib numbers and bib-pack shipments back to Let's Do This for the startlist entries they received. Available to select timing partners only. paths: /v0/add-ons/import/{jobId}: get: tags: - AddOns summary: Get add-on import status description: >- Returns task counts and paginated per-product results for an organizer-owned add-on product import. Poll until the status is completed or cancelled. parameters: - schema: type: - number - 'null' minimum: 1 maximum: 50 example: 50 in: query name: page[size] required: false description: >- The number of import results to return per page. Range between 1 - 50, defaults to 50. - schema: type: - string - 'null' in: query name: page[after] required: false description: >- Accepts an existing page cursor. For more details see the definition of PageCursor in the response. - schema: type: - string - 'null' in: query name: page[before] required: false description: >- Accepts an existing page cursor. For more details see the definition of PageCursor in the response. - schema: type: string in: path name: jobId required: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/AddOnProductImportJobStatusResponse' '404': description: Not found content: application/json: schema: description: Not found type: object properties: statusCode: type: number enum: - 404 error: type: string message: type: string components: schemas: AddOnProductImportJobStatusResponse: title: AddOnProductImportJobStatusResponse type: object properties: importId: type: string jobId: type: string status: type: string enum: - queued - processing - completed - cancelled counts: $ref: '#/components/schemas/AddOnProductImportJobCounts' results: type: array items: $ref: '#/components/schemas/AddOnProductExecutionResult' page: $ref: '#/components/schemas/PageCursor' required: - importId - jobId - status - counts - results - page additionalProperties: false description: >- Progress and product results for an asynchronous add-on import. `results` is the outcome: one entry per submitted row, carrying that row's own `status` and `errors`. It is the only field that reports whether any data landed, so decide what to action from it. `status` and `counts` describe progress, and neither reports success. `status` is `completed` once the work finished, including work whose every row was rejected, and `counts` is of internal work units rather than rows. example: importId: 3a55dc4c-6fd2-49bd-90cd-32c65fce7b1a jobId: 65f60718293a4b5c6d7e8f90 status: completed counts: pending: 0 processing: 0 success: 1 failure: 0 cancelled: 0 total: 1 results: - status: succeeded externalAddOnId: city-marathon-tshirt product: externalAddOnId: city-marathon-tshirt addOnId: 5fcd4b7e-1a2c-4d89-8f31-6b72e09a45c3 outcome: created variants: - externalVariantId: city-marathon-tshirt-navy-m variantId: 29bb39a4-3206-4f43-9a6a-79d83fc1c31e outcome: created errors: [] - status: succeeded externalAddOnId: city-marathon-cap product: externalAddOnId: city-marathon-cap addOnId: 7ad1c930-5b64-4e12-9c07-2f8e1d3a6b45 outcome: created variants: - externalVariantId: city-marathon-cap-onesize variantId: 3e5f7a91-8c2d-4b06-a1f4-90d6c7b28e13 outcome: created errors: [] page: totalResults: 2 first: '' last: '' prev: '' next: '' AddOnProductImportJobCounts: title: AddOnProductImportJobCounts type: object properties: pending: type: number processing: type: number success: type: number failure: type: number cancelled: type: number total: type: number required: - pending - processing - success - failure - cancelled - total additionalProperties: false description: >- Progress counts for an import job, tracking internal work units rather than rows. One unit covers a server-side chunk of the submitted batch, so `total` does not correspond to the number of rows submitted, and a unit that runs to completion counts as `success` even when every one of its rows failed validation. Per-row outcomes, including failures, are reported in `results`, not here. AddOnProductExecutionResult: title: AddOnProductExecutionResult type: object properties: status: type: string enum: - pending - succeeded - failed externalAddOnId: type: string product: $ref: '#/components/schemas/AddOnProductImportResult' errors: type: array items: $ref: '#/components/schemas/AddOnProductImportError' required: - status - externalAddOnId - errors additionalProperties: false description: Isolated result for one imported product. PageCursor: title: PageCursor type: object properties: totalResults: type: number description: The total number of results available. first: type: string description: The cursor for the first page of results. last: type: string description: The cursor for the last page of results. prev: type: string description: The cursor for the previous page of results. next: type: string description: The cursor for the next page of results. required: - totalResults - first - last - prev - next additionalProperties: false description: >- **Cursor details for pagination**. - In scenarios with large amounts of data, it's common to return only a subset of data in a single request, known as a "page". - Most API responses include two objects: a 'data' object with the query results, and a 'PageCursor' object detailing the current page. - Cursors can be used to navigate to earlier or later pages in the set of results. For instance, passing the 'next' cursor from 'PageCursor' fetches the next set of results. - Cursors are base64 encoded strings. example: totalResults: 506 first: >- eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9 last: >- eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9 prev: '' next: >- eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9 AddOnProductImportResult: title: AddOnProductImportResult type: object properties: externalAddOnId: type: string addOnId: type: string outcome: $ref: '#/components/schemas/AddOnProductImportOutcome' variants: type: array items: $ref: '#/components/schemas/AddOnVariantImportResult' required: - externalAddOnId - addOnId - outcome - variants additionalProperties: false AddOnProductImportError: title: AddOnProductImportError type: object properties: code: type: string message: type: string fieldId: type: string required: - code - message additionalProperties: false AddOnProductImportOutcome: title: AddOnProductImportOutcome type: string enum: - created - updated - unchanged - alreadyImported AddOnVariantImportResult: title: AddOnVariantImportResult type: object properties: externalVariantId: type: string variantId: type: string outcome: $ref: '#/components/schemas/AddOnProductImportOutcome' required: - externalVariantId - variantId - outcome additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````