GET /api/v2/shared_references
List Shared references

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": "shared_reference_1",
            "name": "Shared reference 1",
            "product_class": {
                "id": 7,
                "name": "Season"
            },
            "product_family": {
                "id": 1,
                "code": "family_1",
                "name": "Family 1"
            },
            "attribute_values": [
                {
                    "attribute_definition_id": 16,
                    "attribute_definition_code": "season",
                    "data": "Winter"
                }
            ]
        }
      ]
  }

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

Shared reference ID

Validations:

  • Must be a String
code
optional

Shared reference code

Validations:

  • Must be a String
name
optional

Shared reference name

Validations:

  • Must be a String
response_associated_fields
optional

One of ‘product_class’, ‘product_family’, ‘attribute_values’. The information related to the Shared reference to be included in the Shared reference data response. Use comma to join multiple fields.

Validations:

  • Must be a String