Retrieve a price list scheduler

How to fetch a specific price list scheduler via API

To fetch a single price list scheduler, send a GET request to the /api/price_list_schedulers/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/price_list_schedulers/:id

Example

Request

The following request fetches the price list scheduler identified by the id "xYZkjABcde":

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde' \
  -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 single resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "price_list_schedulers",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde"
    },
    "attributes": {
      "name": "FW SALE 2023",
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "active": true,
      "status": "pending",
      "disabled_at": "2018-01-01T12:00:00.000Z",
      "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"
      }
    },
    "relationships": {
      "market": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/relationships/market",
          "related": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/market"
        }
      },
      "price_list": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/relationships/price_list",
          "related": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/price_list"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/events"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/price_list_schedulers/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}