v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Channels

BulkRetrieveChannels

post/v2/channels/bulk-retrieve

Request body

channel_idsstring[] required

Example request

{
  "channel_ids": [
    "CH_9C03D0B59",
    "CH_6X139B5MN",
    "NOT_EXISTING"
  ]
}

Response

Success

responsesobject

A map of channel IDs to channel responses which tell whether retrieval for a specific channel is success or not. Channel response of a success retrieval would contain channel info whereas channel response of a failed retrieval would have error info.

Example response

{
  "responses": {
    "CH_6X139B5MN": {
      "channel": {
        "created_at": "2022-10-25T16:27:00Z",
        "id": "CH_6X139B5MN",
        "merchant_id": "ML64FACEA",
        "name": "Contoso Fulfillment Application",
        "reference": {
          "id": "OA_9C03D0444",
          "type": "OAUTH_APPLICATION"
        },
        "status": "ACTIVE",
        "updated_at": "2022-10-25T16:48:00Z",
        "version": 1
      }
    },
    "CH_9C03D0B59": {
      "channel": {
        "created_at": "2022-10-25T16:27:00Z",
        "id": "CH_9C03D0B59",
        "merchant_id": "ML64FACEA",
        "name": "State Street Store",
        "reference": {
          "id": "OA_9C03D0B59",
          "type": "LOCATION"
        },
        "status": "ACTIVE",
        "updated_at": "2022-10-25T16:48:00Z",
        "version": 1
      }
    },
    "NOT_EXISTING": {
      "errors": [
        {
          "code": "NOT_FOUND"
        }
      ]
    }
  }
}