Get ProductList

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (ProductList)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

ProductList

Example:

ProductList

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
  "data": {
    "id": "FID001",
    "type": "ProductList",
    "attributes": {
      "name": "string",
      "description": "string"
    },
    "relationships": {
      "products": {
        "data": [
          {
            "id": "FID001",
            "type": "Product"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "FID001",
      "type": "_User",
      "attributes": {},
      "relationships": {
        "property1": {
          "data": {
            "id": "FID001",
            "type": "_User"
          },
          "links": {
            "self": "string",
            "related": "string"
          },
          "meta": {}
        },
        "property2": {
          "data": {
            "id": "FID001",
            "type": "_User"
          },
          "links": {
            "self": "string",
            "related": "string"
          },
          "meta": {}
        }
      }
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Request

Request samples

Responses