Product_collections

>>>

GET /api/product_collections/:id
Get product collection metadata

Consult product_collection response schema for resonse details and examples.

Params

Param name Description
id
required

Product Collection ID

Validations:

  • Must be a number.

Headers

Header name Description
Accept
required 		application/vnd.api+json; com.pixelsquid.api.version=1
Authorization
required 		Base64 encoding of [key_id]:[secret]

For example:
Basic REVWRUxPUEVSX1BBQ0s6cGl4ZWxzcXVpZHNhbXBsZQ==

The following sample api key may be used for development purposes only:

key_id: DEVELOPER_PACK
secret: pixelsquidsample

X-Client-External-User-ID
optional 		You may pass this header to associate any api requests
with the unique identifier of the end user.
>>>

GET /api/product_collections
Product Collection Search

Params

Param name Description
sort
optional

Sort order

Validations:

  • Must be a String
filter
optional

Filter conditions

Validations:

  • Must be a Hash
filter[name]
optional

Filter by name

Validations:

  • Must be a String
page
optional

Pagination options

Validations:

  • Must be a Hash
page[number]
optional

Page number to return from paginated collection

Validations:

  • Must be a number.
page[size]
optional

Results per page to return

Validations:

  • Must be a number.

Headers

Header name Description
Accept
required 		application/vnd.api+json; com.pixelsquid.api.version=1
Authorization
required 		Base64 encoding of [key_id]:[secret]

For example:
Basic REVWRUxPUEVSX1BBQ0s6cGl4ZWxzcXVpZHNhbXBsZQ==

The following sample api key may be used for development purposes only:

key_id: DEVELOPER_PACK
secret: pixelsquidsample

X-Client-External-User-ID
optional 		You may pass this header to associate any api requests
with the unique identifier of the end user.