Brands

Resource Representation ↑

Example:
{
  "id": 1,
  "name": "Brand Name",
  "description": null,
  "logo_link": ""
}

Supported Formats

json
>>>

GET /api/v2/brands
List brands

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 1,
        "name": "Brand Name",
        "description": null,
        "logo_link": ""
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
lang
optional

Language code for translated value

Validations:

  • Must be a String
>>>

POST /api/v2/brands
Create an brand

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "brand": {
          "name": "Test",
      }
  }

response:
  {
    "id": 6,
    "name": "Test",
    "description": null,
    "logo_link": ""
  }

Params

Param name Description
brand
required

Validations:

  • Must be a Hash
brand[name]
required

Name of the brand

Validations:

  • Must be a String
brand[description]
optional , nil allowed

Description of the brand

Validations:

  • Must be a String
brand[logo_url]
optional , nil allowed

Logo URL

Validations:

  • Must be a String
>>>

PUT /api/v2/brands/:id
Update an brand

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "brand": {
        "name": "Test Updated",
    }
  }

response:
  {
    "id": 6,
    "name": "Test Updated",
    "description": null,
    "logo_link": ""
  }

Params

Param name Description
brand
required

Validations:

  • Must be a Hash
brand[name]
optional

Name of the brand

Validations:

  • Must be a String
brand[description]
optional , nil allowed

Description of the brand

Validations:

  • Must be a String
brand[logo_url]
optional , nil allowed

Logo URL

Validations:

  • Must be a String
>>>

DELETE /api/v2/brands/:id
Delete an brand

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 6
  }