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:
    {
      "product_catalog": {
        "product_id": 257,
        "catalog_id": 16
      }
    }

  response:
    {
      "id": 6,
      "product_id": 257,
      "category_id": 16
    }

Sample: Insert product catalog with product code.
  request:
    {
      "product_catalog": {
        "product_code": "product_code_1",
        "catalog_id": 16
      }
    }

  response:
    {
      "id": 6,
      "product_id": 257,
      "category_id": 16
    }

Params

Param name Description
product_catalog
required

Validations:

  • Must be a Hash

product_catalog[product_id]
optional , nil allowed

Product ID

Validations:

  • Must be a Integer

product_catalog[product_code]
optional , nil allowed

Product Code

Validations:

  • Must be a String

product_catalog[catalog_id]
required

Catalog ID

Validations:

  • Must be a Integer