Resource:list combining abbreviated info about skus and item aliasesC# Rel Const:Rels.CustomerSvc.SkusUnionAliasesURI template:{id}/skusunionaliases{?pgsiz,pgnum,contains}Obtain URI from:
Get list of item skus combined with item aliases, sorted by sku (regarding an alias as if it were a sku)
Success status: 200; Response is cacheable
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 |
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 | |
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 |
{ "totalResults": 1, "_embedded": { "item": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "description": "str", "inventoryUnitIdentifier": { "name": "str", "id": 2 }, "secondaryUnit": { "inventoryAlso": true, "upc": "str", "unitIdentifier": { "name": "str", "id": 2 }, "inventoryUnitsPerUnit": 3.0 }, "qualifiers": [ "str" ] } ] } }
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.