Skip to content

Latest commit

 

History

History
61 lines (51 loc) · 763 Bytes

product_lists.md

File metadata and controls

61 lines (51 loc) · 763 Bytes
Raw

product_lists

GET /api/v1/product_lists

Required scope: read_catalog, catalog

Sample Model

{
	"id": 1,
	"name": "Stuff"
}

Nested Resources

Accessible via the ?expand= parameter or /api/v1/product_lists/{id}/{nested_resource}.

items

GET /api/v1/product_lists?expand=items
GET /api/v1/product_lists/{id}/items
{
	...
	"product_lists": [
		{
			"id": 1,
			"product_id": 1,
			"sort_order": 0,
			"variant_inventory_id": null
		},
		{
			"id": 2,
			"product_id": 6,
			"sort_order": 0,
			"variant_inventory_id": null
		},
		{
			"id": 3,
			"product_id": 7,
			"sort_order": 0,
			"variant_inventory_id": null
		},
		...
	],
	...
}