REL documentation
customers markforlists (http://api.3plcentral.com/rels/customers/markforlists)
Resource:
Collection: of markforlist
C# Rel Const:
Rels.CustomerSvc.MarkForLists
URI template:
{id}/markforlists
Obtain URI from:
/rels/customers/customer
obtain all mark-for lists for given customer
each entry is list of store ids marked for grouped processing
Success status: 200
Name (* = required) Data Type Description
id * int customer id
Type Description
ResourceList IList<Customer.Models.MarkForList>
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
{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/markforlist": [
      {
        "markForListId": 1,
        "name": "str",
        "storeIds": [
          "str"
        ]
      }
    ]
  }
}
create a new mark-for list for given customer
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer 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
new 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"
  ]
}

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.