Retrieve a source

Retrieve a source by its ID.

GET /1/sources/{sourceID}

curl

cURL

curl --request GET \
  --url https://data.us.algolia.com/1/sources/6c02aeb1-775e-418e-870b-1faccd4b2c0f \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "type": "bigcommerce",
  "name": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "owner": "<string>",
  "input": {
    "url": "<string>",
    "projectKey": "<string>",
    "storeKeys": [
      "<string>"
    ],
    "locales": [
      "fr-FR"
    ],
    "fallbackIsInStockValue": true,
    "productQueryPredicate": "<string>",
    "useImagesObjects": true,
    "customFields": {
      "inventory": [
        "<string>"
      ],
      "price": [
        "<string>"
      ],
      "category": [
        "<string>"
      ]
    }
  },
  "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
}

Required ACL: addObject, deleteIndex, editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

sourceID · string · required

Unique identifier of a source. Universally uniqud identifier (UUID) of a source.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

Response

200

application/json

OK

sourceID · string · required

Universally uniqud identifier (UUID) of a source.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

type · enum<string> · required

Available options: bigcommerce, bigquery, commercetools, csv, docker, ga4BigqueryExport, json, shopify, push

name · string · required

createdAt · string · required

Date of creation in RFC 3339 format.

updatedAt · string · required

Date of last update in RFC 3339 format.

owner · string | null

Owner of the resource.

input · object

Specific configuration attributes of a commercetools source.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

input. url · string · required

input. projectKey · string · required

input. storeKeys · string[]

Unique and immutable key of the referenced store.

input. locales · string[]

Locales for your commercetools stores.

Locale specified as combination of a two-letter language code and an optional two-letter country code.

input. fallbackIsInStockValue · boolean · default: true

Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.

input. productQueryPredicate · string

Predicate to filter out specific products when indexing. For more information, see Query Predicate.

input. useImagesObjects · boolean

When set to true, the connector indexes objects with all images attributes instead of only the URLs.

input. customFields · object

Custom fields from commercetools to add to the records.

For more information, see Using Custom Types and Custom Fields.

Show child attributes

input.customFields. inventory · string[] | null

Inventory custom fields.

input.customFields. price · string[] | null

Price custom fields.

input.customFields. category · string[] | null

Category custom fields.

authenticationID · string

Universally unique identifier (UUID) of an authentication resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"