Resource:Collection: of itemaliasC# Rel Const:Rels.CustomerSvc.ItemAliasListURI template:{id}/itemaliases{?pgsiz,pgnum,rql,sort}Obtain URI from:
Success status: 200
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | |
pgsiz | int | max records to return per response; use "next" or "prev" link to paginate |
pgnum | int | considering pgsiz, returns the pgnum-th page, 1-indexed |
rql | string | see RQL documentation |
sort | string | see RQL documentation |
Type | Description | |
---|---|---|
TotalResults | int | |
ResourceList | IList<Customer.Models.ItemAlias> | |
AliasIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Active | bool | |
Description | string | |
Details | IEnumerable<Customer.Models.AliasDetail> | |
ItemIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Qty | decimal | |
Description | string | |
Links | IList<WebApi.Hal.Link> | |
- /rels/customers/customer | ||
Links | IList<WebApi.Hal.Link> | |
- next | ||
- prev |
{ "totalResults": 1, "_embedded": { "http://api.3plCentral.com/rels/customers/itemalias": [ { "aliasIdentifier": { "sku": "str", "id": 2 }, "active": true, "description": "str", "details": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "qty": 1.0, "description": "str" } ] } ] } }
Success status: 201
Name (* = required) | Data Type | Description |
---|---|---|
id * | int |
Type | Description | |
---|---|---|
AliasIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Active | bool | |
Description | string | |
Details | IEnumerable<Customer.Models.AliasDetail> | |
ItemIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Qty | decimal | |
Description | string |
Sample content-type: application/hal+json |
{ "aliasIdentifier": { "sku": "str", "id": 2 }, "active": true, "description": "str", "details": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "qty": 1.0, "description": "str" } ] }
Type | Description | |
---|---|---|
AliasIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Active | bool | |
Description | string | |
Details | IEnumerable<Customer.Models.AliasDetail> | |
ItemIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Qty | decimal | |
Description | string | |
Links | IList<WebApi.Hal.Link> | |
- /rels/customers/customer |
{ "aliasIdentifier": { "sku": "str", "id": 2 }, "active": true, "description": "str", "details": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "qty": 1.0, "description": "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.