Product families

Resource Representation ↑

Example:
{
  "id": 1,
  "code": "Product family 1",
  "name": "Product family 1"
}

Supported Formats

json
>>>

GET /api/v2/product_families
List product families

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,
              "code": "fam1",
              "name": "fam1",
              "attribute_groups": [
                  {
                      "product_class_id": 3,
                      "attribute_group_id": 2,
                      "sort_order": 1
                  },
                  {
                      "product_class_id": 7,
                      "attribute_group_id": 6,
                      "sort_order": 2
                  },
                  {
                      "product_class_id": 7,
                      "attribute_group_id": 5,
                      "sort_order": 3
                  }
              ]
          }
      ]
  }

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.
created_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
created_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
id
optional

Attribute group ID

Validations:

  • Must be a String
>>>

POST /api/v2/product_families
Create or update product family

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_family": {
      "code": "family_1",
      "name": "Family 1",
      "attribute_groups": [
        {
          "product_class_name": "class1",
          "attribute_group_code": "grp1",
          "sort_order": 1
        },
        {
          "product_class_name": "class2",
          "attribute_group_code": "grp2",
          "sort_order": 2
        }
      ]
    }
  }

response:
  {
      "id": 3,
      "code": "family_2",
      "created_at": "2019-06-18T13:31:16.763+10:00",
      "updated_at": "2019-06-18T13:31:16.763+10:00",
      "name": "Family 2"
  }

Params

Param name Description
product_family
required

Validations:

  • Must be a Hash
product_family[code]
required

Code of the product family

Validations:

  • Must be a String
product_family[name]
required

Name of the product family

Validations:

  • Must be a String
product_family[attribute_groups]
optional , nil allowed

Link family to attribute groups for product classes

Validations:

  • Must be an Array of nested elements
product_family[attribute_groups][product_class_name]
optional , nil allowed

Product class name

Validations:

  • Must be a String
product_family[attribute_groups][attribute_group_code]
optional , nil allowed

Attribute group code

Validations:

  • Must be a String
product_family[attribute_groups][sort_order]
optional , nil allowed

Sort order

Validations:

  • Must be a Integer
>>>

DELETE /api/v2/product_families/:id
Delete a product family

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": 2
  }