OfferCategory

Retrieves the collection of OfferCategory resources.

get

The group parameter can be use to load additional data. Use 'groups[]=translation' to load translations as well.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

groups[]string[]Optional

Responses

200

OfferCategory collection

application/ld+jsontext/html

hydra:totalItemsintegerOptional

get

/api/offer_categories

HTTPcURLJavaScriptPython

GET /api/offer_categories HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OfferCategory collection

{
  "hydra:member": [
    {
      "@id": "text",
      "@type": "text",
      "@context": "text",
      "id": 1,
      "internalName": "text",
      "nameTranslations": [
        {
          "@context": "text",
          "@id": "text",
          "@type": "text",
          "language": "/entitiy/1",
          "content": "text"
        }
      ],
      "descriptionTranslations": [
        {
          "@context": "text",
          "@id": "text",
          "@type": "text",
          "language": "/entitiy/1",
          "content": "text"
        }
      ],
      "frame": "/entitiy/1",
      "mode": "single",
      "isMandatory": true
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "text",
    "hydra:template": "text",
    "hydra:variableRepresentation": "text",
    "hydra:mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": "text",
        "required": true
      }
    ]
  }
}

Retrieves a OfferCategory resource.

get

The group parameter can be use to load additional data. Use 'groups[]=translation' to load translations as well.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

OfferCategory resource

application/ld+jsontext/html

Category

@idstringRead-onlyOptional

@typestringRead-onlyOptional

@contextone ofRead-onlyOptional

stringOptional

or

idintegerOptional

The unique identifier for the offer category

internalNamestringOptional

The internal name of the offer category

framestring · iri-referenceOptional

The frame containing this offer category

modestring · enumOptional

The mode of the offer category

Possible values:

isMandatorybooleanOptional

Whether or not the offer category is mandatory

404

Resource not found

get

/api/offer_categories/{id}

HTTPcURLJavaScriptPython

GET /api/offer_categories/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@id": "text",
  "@type": "text",
  "@context": "text",
  "id": 1,
  "internalName": "text",
  "nameTranslations": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "language": "/entitiy/1",
      "content": "text"
    }
  ],
  "descriptionTranslations": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "language": "/entitiy/1",
      "content": "text"
    }
  ],
  "frame": "/entitiy/1",
  "mode": "single",
  "isMandatory": true
}