NielsenIQ Rdecosystem Controller API

RDecoSystem Controller

Operations 9

GET /rddispatch getRdDispatchResp #
GET /rdimagedispatch getRdimageDispatchResp #
POST /rejectImage rejectImageResp #
GET /rddispatch/icv/nankey/{id} getRdICVDispatchforNanKeyResp #
GET /rddispatch/icv/extrncd/{id} getRdICVDispatchforExtrncodeResp #
POST /rddispatch/icv/ack/id/{id} postackRdICVDispatchforIDResp #
POST /rddispatch/icv/ack postackRdICVDispatchResp #
GET /rddispatch/icv getRdICVDispatchResp #
POST /rddispatch/product/create postCreateProductResp #

Documentation

📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=BDAMetaDataCatalogues
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARBARTER
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARBARTERAPI
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARECOLLECTION
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARECOLLECTIONAPI
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGETTOKEN
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGETTOKENPRODNA
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGNIC
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGNICAPI
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGNICUS
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARGNICUSAPI
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CDARVendorReports
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CIPGalaxyFormProxy
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CIPGalaxyProxy
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=CRMCasetrackAPI
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=docusearch-azure-openai-service-api
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=Rdecosystem
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=RdecosystemBB
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=StoreAvailabilityBulk
📖
Documentation
https://portal.developer.nielseniq.com/api-details#api=68af1bb26127b356b25adb0c

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-catalogues-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-catalogues-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-barter-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-barter-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-barter-request-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-barter-resp-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-ecollection-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-ecollection-resp-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gettoken-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gettoken-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gettokenprodna-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gettokenprodna-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-request-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-resp-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-request-us-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-resp-us-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-request-usapi-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-gnic-resp-usapi-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-get-audit-summary-report-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-function-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-function-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-create-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-image-generations-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-content-filter-choice-results-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-create-chat-completion-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-audio-verbose-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-generate-images-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-reject-image-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rdecosystem-rd-icvdispatch-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rdecosystem-ack-rd-icvdispatch-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-post-create-product-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rd-dispatch-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rdecosystem-rdimagedispatch-get200-image-png-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rd-foundational-feed-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-reset-bb-processing-status-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-update-bb-processing-status-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-reset-bb-processing-status-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-update-bb-processing-status-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-rdecosystembb-rdimagedispatch-get200-image-png-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-job-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-add-check-digit-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-batch-store-availability-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/nielseniq/json-schema/nielseniq-batch-store-availability-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nielseniq:nielseniq-rdecosystem-controller-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nielseniq-rdecosystem-controller-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nielseniq Rdecosystem Controller API
  version: '1.0'
  description: 'Operations tagged rdecosystem-controller across 2 of this provider''s published API definitions: Rdecosystem.yml, nielseniq-rdecosystem-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.developer.nielseniq.com/rdecosystem
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: rdecosystem-controller
  description: RDecoSystem Controller
paths:
  /rddispatch:
    get:
      tags:
      - rdecosystem-controller
      summary: getRdDispatchResp
      operationId: getRdDispatchRespUsingGET
      parameters:
      - name: page
        in: query
        description: page
        schema:
          type: string
      - name: size
        in: query
        description: size
        schema:
          type: string
      - name: fromDate
        in: query
        description: fromDate
        schema:
          type: string
      - name: endDate
        in: query
        description: endDate
        schema:
          type: string
      - name: provider
        in: query
        description: provider
        schema:
          type: string
      - name: Authorization
        in: header
        description: Authorization
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: subscription-key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RdDispatchResp'
              example:
                user:
                - nielsenExternalCode: string
                  dispatchDate: string
                  dispatchId: string
                  commodityGroup: string
                  images:
                  - imgId: string
                    imgUrl: string
                    imgSourcedDate: string
                  imageSource: string
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rdimagedispatch:
    get:
      tags:
      - rdecosystem-controller
      summary: getRdimageDispatchResp
      operationId: getRdimageDispatchRespUsingGET
      parameters:
      - name: imgId
        in: query
        description: imgId
        schema:
          type: string
      - name: subscription-key
        in: header
        description: subscription-key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/RdecosystemRdimagedispatchGet200ImagePngResponse'
              example: ''
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rejectImage:
    post:
      tags:
      - rdecosystem-controller
      summary: rejectImageResp
      operationId: rejectImageRespUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: subscription-key
        required: true
        schema:
          type: string
      requestBody:
        description: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rejectImageRequest'
            example:
              dispatchStatus: string
              dateEntered: string
              dispatchId: string
              nielsenExternalCode: string
              rejectedReason: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rejectImageResp'
              example: string
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/icv/nankey/{id}:
    get:
      tags:
      - rdecosystem-controller
      summary: getRdICVDispatchforNanKeyResp
      operationId: getRdICVDispatchforNanKeyRespUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      - name: size
        in: query
        description: Page Size
        schema:
          type: integer
          default: 20
      - name: provider
        in: query
        description: Data provider
        schema:
          type: string
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/icv/extrncd/{id}:
    get:
      tags:
      - rdecosystem-controller
      summary: getRdICVDispatchforExtrncodeResp
      operationId: getRdICVDispatchforExtrncodeRespUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      - name: size
        in: query
        description: Page Size
        schema:
          type: integer
          default: 20
      - name: provider
        in: query
        description: Data provider
        schema:
          type: string
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/RdecosystemRdICVdispatchResponse'
              example: ''
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/icv/ack/id/{id}:
    post:
      tags:
      - rdecosystem-controller
      summary: postackRdICVDispatchforIDResp
      operationId: postackRdICVDispatchforIDRespUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/icv/ack:
    post:
      tags:
      - rdecosystem-controller
      summary: postackRdICVDispatchResp
      operationId: postackRdICVDispatchRespUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/RdecosystemAckRdICVdispatchResponse'
              example: ''
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/icv:
    get:
      tags:
      - rdecosystem-controller
      summary: getRdICVDispatchResp
      operationId: getRdICVDispatchRespUsingGET
      parameters:
      - name: size
        in: query
        description: Page Size
        schema:
          type: integer
          default: 20
      - name: provider
        in: query
        description: Data provider
        schema:
          type: string
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/RdecosystemRdICVdispatchResponse'
              example: ''
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
  /rddispatch/product/create:
    post:
      tags:
      - rdecosystem-controller
      summary: postCreateProductResp
      operationId: postCreateProductRespUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Auth Token
        required: true
        schema:
          type: string
      - name: subscription-key
        in: header
        description: API Subscription key
        required: true
        schema:
          type: string
      requestBody:
        description: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postCreateProductRequest'
            example:
              data: {}
      responses:
        '200':
          description: Success
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json: {}
        '403':
          description: Forbidden
          content:
            application/json: {}
        '404':
          description: Not found
          content:
            application/json: {}
        '500':
          description: Failure
          content:
            application/json: {}
    servers:
    - url: https://api.developer.nielseniq.com/rdecosystem
components:
  schemas:
    RdDispatch:
      title: RdDispatch
      type: object
      properties:
        nielsenExternalCode:
          type: string
        dispatchDate:
          type: string
        dispatchId:
          type: string
        commodityGroup:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Images'
        imageSource:
          type: string
    postCreateProductRequest:
      title: Content
      type: object
      properties:
        data:
          type: object
          items:
            $ref: '#/components/schemas/CreateProduct'
    SyndicatedChars:
      title: SyndicatedChars
      type: object
      properties:
        SyndicatedCharsObj:
          type: object
          items:
            $ref: '#/components/schemas/SyndicatedCharsObj'
    RdecosystemRdimagedispatchGet200ImagePngResponse:
      type: string
      format: binary
    RdecosystemAckRdICVdispatch:
      title: RdecosystemAckRdICVdispatch
      type: string
    RdDispatchResp:
      title: Content
      type: object
      properties:
        user:
          type: array
          items:
            $ref: '#/components/schemas/RdDispatch'
    RdecosystemRdICVdispatchResponse:
      title: Content
      type: object
      properties:
        user:
          type: array
          items:
            $ref: '#/components/schemas/RdecosystemRdICVdispatch'
        hasMoreRecords:
          type: boolean
        size:
          type: integer
    rejectImageRequest:
      title: Content
      type: object
      properties:
        dispatchStatus:
          type: string
        dateEntered:
          type: string
        dispatchId:
          type: string
        nielsenExternalCode:
          type: string
        rejectedReason:
          type: string
    RdecosystemRdICVdispatch:
      title: RdecosystemRdICVdispatch
      type: object
      properties:
        id:
          type: string
        country:
          type: string
        extrnCode:
          type: string
        nanKey:
          type: string
        gic:
          type: integer
        cntlChr:
          type: object
          items:
            $ref: '#/components/schemas/CntlChr'
        chrs:
          type: array
          items:
            $ref: '#/components/schemas/Chrs'
        itmCrtDttm:
          type: string
        itmUpdDttm:
          type: string
        updDttm:
          type: string
    CntlChr:
      title: CntlChr
      type: object
      properties:
        chrCd:
          type: integer
        chrLclCd:
          type: string
        chrDscr:
          type: string
        chrVal:
          type: object
          items:
            $ref: '#/components/schemas/ChrVal'
    rejectImageResp:
      title: Content
      type: string
    GtinFormats:
      title: GtinFormats
      type: object
      properties:
        UPC_A:
          type: string
        ON_PACK:
          type: string
        NO_CHECK_DIGIT:
          type: string
        GTIN_14:
          type: string
    ChrVal:
      title: ChrVal
      type: object
      properties:
        chrValCd:
          type: integer
        chrValLclCd:
          type: string
        chrValDscr:
          type: string
        seq:
          type: integer
    SyndicatedCharsObj:
      title: SyndicatedCharsObj
      type: object
      properties:
        characteristic:
          type: string
        value:
          type: string
    Images:
      title: Images
      type: object
      properties:
        imgId:
          type: string
        imgUrl:
          type: string
        imgSourcedDate:
          type: string
    CreateProduct:
      title: Content
      type: object
      properties:
        upc:
          type: string
        productId:
          type: integer
        gtinFormats:
          type: object
          items:
            $ref: '#/components/schemas/GtinFormats'
        syndicatedChars:
          type: array
          items:
            $ref: '#/components/schemas/SyndicatedChars'
    RdecosystemAckRdICVdispatchResponse:
      title: Content
      type: object
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/RdecosystemAckRdICVdispatch'
    Chrs:
      title: Chrs
      type: object
      properties:
        ChrsContent:
          type: object
          items:
            $ref: '#/components/schemas/CntlChr'
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: subscription-key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
x-refined-from:
- Rdecosystem.yml
- nielseniq-rdecosystem-openapi.yml