A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"styleId": 123,
"description": "<string>",
"position": 123,
"quantity": 123,
"dateAdded": "2023-11-07T05:31:56Z",
"state": "active",
"itemSize": {
"id": 123,
"name": "<string>",
"state": "active",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"position": 123,
"physicalReferenceNumber": "<string>",
"erpSizeId": "<string>",
"properties": [
"<string>"
]
},
"item": {
"id": 123,
"name": "<string>",
"customId": "<string>",
"state": "active",
"description": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"organization": {
"id": 123,
"name": "<string>"
},
"supplier": {
"id": 123,
"name": "<string>",
"customId": "<string>"
},
"companyContactPerson": {
"id": "<string>",
"name": "<string>"
},
"supplierContactPerson": {
"id": "<string>",
"name": "<string>"
},
"categories": [
{
"id": 123,
"name": "<string>"
}
],
"parts": [
{
"id": 123,
"name": "<string>",
"value": 123,
"unit": "<string>",
"materials": [
{
"id": 123,
"name": "<string>",
"percentage": 123
}
]
}
],
"adminUnit": {
"id": 123,
"name": "<string>",
"customId": "<string>",
"properties": [
"<string>"
]
},
"logo": {
"id": "<string>",
"url": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"erpItemId": "<string>",
"defaultQty": 123,
"nameGeneratorExtraText": "<string>",
"physicalReferenceNumber": "<string>",
"properties": [
"<string>"
]
},
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Lists style items across the organization.
Org-wide list, filterable by styleId, itemId, state, and properties=mainItem. Supply filter + sort + pageSize + pageNumber for page-based results, or a cursor for cursor-based results; cursor is mutually exclusive with filter/sort/pageSize/pageNumber.
A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"styleId": 123,
"description": "<string>",
"position": 123,
"quantity": 123,
"dateAdded": "2023-11-07T05:31:56Z",
"state": "active",
"itemSize": {
"id": 123,
"name": "<string>",
"state": "active",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"position": 123,
"physicalReferenceNumber": "<string>",
"erpSizeId": "<string>",
"properties": [
"<string>"
]
},
"item": {
"id": 123,
"name": "<string>",
"customId": "<string>",
"state": "active",
"description": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"organization": {
"id": 123,
"name": "<string>"
},
"supplier": {
"id": 123,
"name": "<string>",
"customId": "<string>"
},
"companyContactPerson": {
"id": "<string>",
"name": "<string>"
},
"supplierContactPerson": {
"id": "<string>",
"name": "<string>"
},
"categories": [
{
"id": 123,
"name": "<string>"
}
],
"parts": [
{
"id": 123,
"name": "<string>",
"value": 123,
"unit": "<string>",
"materials": [
{
"id": 123,
"name": "<string>",
"percentage": 123
}
]
}
],
"adminUnit": {
"id": 123,
"name": "<string>",
"customId": "<string>",
"properties": [
"<string>"
]
},
"logo": {
"id": "<string>",
"url": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"erpItemId": "<string>",
"defaultQty": 123,
"nameGeneratorExtraText": "<string>",
"physicalReferenceNumber": "<string>",
"properties": [
"<string>"
]
},
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Query Parameters
Filters results to style items belonging to this style.
Filters results to style items referencing this item from the item library.
Filters results to style items in this lifecycle state. Lifecycle state of the item's placement on the style.
active, inactive, deleted Filters results to style items carrying the given property flags. Only mainItem is currently supported.
Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id.
Show child attributes
Show child attributes
Number of style items to return per page. Defaults to 30, maximum 100.
The 1-based page number to return. Defaults to 1.
Opaque keyset pagination token for the next page. Mutually exclusive with the filter, sort, pageSize and pageNumber parameters.
Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The page of results, always an array. An empty page is an empty array rather than null or an omitted field.
Show child attributes
Show child attributes
Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.
Show child attributes
Show child attributes