List all markets

How to fetch a collection of markets via API

To fetch a collection of markets, send a GET request to the /api/markets endpoint.

Request

GET https://yourdomain.commercelayer.io/api/markets

Example

Request

The following request fetches a collection of markets:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/markets/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "markets",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde"
      },
      "attributes": {
        "number": 1234,
        "name": "EU Market",
        "code": "europe1",
        "facebook_pixel_id": "1234567890",
        "checkout_url": "https://checkout.yourbrand.com/:order_id",
        "external_prices_url": "https://external_prices.yourbrand.com",
        "external_order_validation_url": "https://external_validation.yourbrand.com",
        "private": true,
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        },
        "disabled_at": "2018-01-01T12:00:00.000Z",
        "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c"
      },
      "relationships": {
        "merchant": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/merchant",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/merchant"
          }
        },
        "price_list": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/price_list",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/price_list"
          }
        },
        "inventory_model": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/inventory_model",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/inventory_model"
          }
        },
        "subscription_model": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/subscription_model",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/subscription_model"
          }
        },
        "tax_calculator": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/tax_calculator",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/tax_calculator"
          }
        },
        "customer_group": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/customer_group",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/customer_group"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/attachments"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/versions"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 9 markets (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/markets?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/markets?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/markets?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of markets can be sorted by the following fields:

• name

• code

• id

• created_at

• updated_at

• reference

• reference_origin

• disabled_at

Filterable fields

The list of markets can be filtered by the following fields:

Attributes

• name

• code

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

• disabled_at

Relationships

• merchant

• price_list

• inventory_model

• subscription_model

• tax_calculator

• customer_group

• attachments