Skip to content

Distributor

A distributor is a distribution entity. It belongs to a group and is associated with companies. This resource is read-only and scoped to the authenticated user's group.

Lists Distributors

GET https://domain.com/api/v1/distributors

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": [
    {
      "type": "distributors",
      "id": "<ID>",
      "attributes": {
        "name": "Music Distributor"
      },
      "relationships": {
        "group": {
          "links": {
            "related": "https://domain.com/api/v1/distributors/<ID>/group",
            "self": "https://domain.com/api/v1/distributors/<ID>/relationships/group"
          }
        },
        "companies": {
          "links": {
            "related": "https://domain.com/api/v1/distributors/<ID>/companies",
            "self": "https://domain.com/api/v1/distributors/<ID>/relationships/companies"
          }
        }
      },
      "links": {
        "self": "https://domain.com/api/v1/distributors/<ID>"
      }
    }
  ],
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 20,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://domain.com/api/v1/distributors?page[number]=1&page[size]=20",
    "last": "https://domain.com/api/v1/distributors?page[number]=1&page[size]=20"
  }
}

Filters

Filter Example
Name /distributors?filter[name]=Music Distributor
ID /distributors?filter[id]=1,2,3

Get Distributor

GET https://domain.com/api/v1/distributors/:id

Path Parameters

Name Type Description
id* Number Distributor ID

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": {
    "type": "distributors",
    "id": "<ID>",
    "attributes": {
      "name": "Music Distributor"
    },
    "relationships": {
      "group": {
        "links": {
          "related": "https://domain.com/api/v1/distributors/<ID>/group",
          "self": "https://domain.com/api/v1/distributors/<ID>/relationships/group"
        }
      },
      "companies": {
        "links": {
          "related": "https://domain.com/api/v1/distributors/<ID>/companies",
          "self": "https://domain.com/api/v1/distributors/<ID>/relationships/companies"
        }
      }
    },
    "links": {
      "self": "https://domain.com/api/v1/distributors/<ID>"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://domain.com/api/v1/distributors/<ID>"
  }
}

Response — 404 Not Found

{
  "jsonapi": {
    "version": "1.0"
  },
  "errors": [
    {
      "status": "404",
      "title": "Not Found"
    }
  ]
}