REL documentation
customers markforlist (http://api.3plcentral.com/rels/customers/markforlist)
Resource:
list of store ids marked for grouped processing
C# Rel Const:
Rels.CustomerSvc.MarkForList
URI template:
{id}/markforlists/{mfid}
Obtain URI from:
get a given mark-for list
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
mfid * int list id
contains sequence of store ids to allow grouping orders for processing; an order is associated with a store by having the store id in a saved element called "MarkForID"; one can search for orders (see /orders/digests) having any store id contained within a given list
Type Description
MarkForListId int assigned by the database
Name string known on the database as Description, known here and in the MarkForListIdentifier as Name
StoreIds IEnumerable<string> known on the database as the MarkForListContent table; comes across EDI channels ending up as MarkForID SaveElements
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "markForListId": 1,
  "name": "str",
  "storeIds": [
    "str"
  ]
}
update a given mark-for list
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
mfid * int list id
contains sequence of store ids to allow grouping orders for processing; an order is associated with a store by having the store id in a saved element called "MarkForID"; one can search for orders (see /orders/digests) having any store id contained within a given list
modified mark-for
Type Description
MarkForListId int assigned by the database
Name string known on the database as Description, known here and in the MarkForListIdentifier as Name
StoreIds IEnumerable<string> known on the database as the MarkForListContent table; comes across EDI channels ending up as MarkForID SaveElements
Sample content-type: application/hal+json
 
{
  "markForListId": 1,
  "name": "str",
  "storeIds": [
    "str"
  ]
}
contains sequence of store ids to allow grouping orders for processing; an order is associated with a store by having the store id in a saved element called "MarkForID"; one can search for orders (see /orders/digests) having any store id contained within a given list
Type Description
MarkForListId int assigned by the database
Name string known on the database as Description, known here and in the MarkForListIdentifier as Name
StoreIds IEnumerable<string> known on the database as the MarkForListContent table; comes across EDI channels ending up as MarkForID SaveElements
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "markForListId": 1,
  "name": "str",
  "storeIds": [
    "str"
  ]
}
delete a given mark-for list
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int customer id
mfid * int list id

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.