| Name
(* = required)
|
Data Type | Description |
| id
*
|
int |
customer id |
| pgsiz
|
int |
must be positive; limit 100, specifying more is an error; default 0;
max records to return per response; use "next" or "prev" link to paginate
|
| pgnum
|
int |
considering pgsiz, returns the pgnum-th page, 1-indexed
|
| contains
|
string |
if specified, limits list to those skus and aliases containing given string |
combined list of skus and aliases
|
Type |
Description |
| TotalResults |
int
|
|
| ResourceList |
IList<Customer.Models.SkuOrAlias>
|
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
negative Id means this is an alias; Sku is Item.Sku for an item, ItemAlias.Alias for an alias
|
| Sku |
string
|
|
| Id |
int
|
|
| Description |
string
|
|
| InventoryUnitIdentifier |
Generic.Models.UnitOfMeasureIdentifier
|
not present for an Alias
|
| Name |
string
|
|
| Id |
int
|
|
| SecondaryUnit |
Customer.Models.SecondaryUnit
|
not present for an Alias
|
| InventoryAlso |
bool
|
|
| Upc |
string
|
|
| Imperial |
Customer.Models.DimensionNet
|
|
| NetWeight |
decimal?
|
|
| Length |
decimal?
|
|
| Width |
decimal?
|
|
| Height |
decimal?
|
|
| Weight |
decimal?
|
|
| Metric |
Customer.Models.DimensionNet
|
|
| NetWeight |
decimal?
|
|
| Length |
decimal?
|
|
| Width |
decimal?
|
|
| Height |
decimal?
|
|
| Weight |
decimal?
|
|
| UnitIdentifier |
Generic.Models.UnitOfMeasureIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| InventoryUnitsPerUnit |
decimal
|
|
| Qualifiers |
IEnumerable<string>
|
not present for an Alias
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/customers/item
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/customers/customer
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"item": [
{
"itemIdentifier": {
"sku": "str",
"id": 2
},
"description": "str",
"inventoryUnitIdentifier": {
"name": "str",
"id": 2
},
"secondaryUnit": {
"inventoryAlso": true,
"upc": "str",
"imperial": {
"netWeight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"metric": {
"netWeight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"unitIdentifier": {
"name": "str",
"id": 2
},
"inventoryUnitsPerUnit": 3.0
},
"qualifiers": [
"str"
]
}
]
}
}