REL documentation
customers suppliers (http://api.3plcentral.com/rels/customers/suppliers)
Resource:
Collection: of supplier
C# Rel Const:
Rels.CustomerSvc.Suppliers
URI template:
{id}/suppliers{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard , /rels/customers/customer
Get a list of suppliers for this customer
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 10; 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.Supplier>
SupplierId int
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsQuickLookup bool
Code string
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Links IList<WebApi.Hal.Link>
- edit
- /rels/customers/customer
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/supplier": [
      {
        "supplierId": 1,
        "companyName": "str",
        "name": "str",
        "title": "str",
        "address1": "str",
        "address2": "str",
        "city": "str",
        "state": "str",
        "zip": "str",
        "county": "str",
        "country": "str",
        "phoneNumber": "str",
        "fax": "str",
        "emailAddress": "str",
        "dept": "str",
        "isQuickLookup": true,
        "code": "str",
        "addressStatus": 0
      }
    ]
  }
}
Create a new supplier
Success status: 201; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
Type Description
SupplierId int
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsQuickLookup bool
Code string
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Sample content-type: application/hal+json
 
{
  "supplierId": 1,
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "county": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isQuickLookup": true,
  "code": "str",
  "addressStatus": 0
}
Type Description
SupplierId int
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsQuickLookup bool
Code string
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Links IList<WebApi.Hal.Link>
- edit
- /rels/customers/customer
Sample accept: application/hal+json
{
  "supplierId": 1,
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "county": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isQuickLookup": true,
  "code": "str",
  "addressStatus": 0
}

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.