Rel doc - Rel

GET

/customers/{id}/itemaliases{?pgsiz,pgnum,rql,sort}

Success status: 200

Params
Response body (Customer.Models.ItemAliasList)

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
ItemDeactivated	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/customer
Links	IList<WebApi.Hal.Link>
	- next
	- prev

Sample accept: application/hal+json

{
  "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",
            "itemDeactivated": true
          }
        ]
      }
    ]
  }
}

POST

/customers/{id}/itemaliases

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
ItemDeactivated	bool

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",
      "itemDeactivated": true
    }
  ]
}

	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
ItemDeactivated	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/customer

Sample accept: application/hal+json

{
  "aliasIdentifier": {
    "sku": "str",
    "id": 2
  },
  "active": true,
  "description": "str",
  "details": [
    {
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qty": 1.0,
      "description": "str",
      "itemDeactivated": true
    }
  ]
}

DELETE

/customers/{id}/itemaliases{?rql}

Delete item aliases from a list of provided alias ids for a specific customer. Error messaging will be returned for each
failed deletion. Aliases that are active will not be deleted.
Success status: 204

Params

Name (* = required)	Data Type	Description
id *	int	The customer id for the aliases being deleted
rql	string	see RQL documentation

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.