REL documentation
customers supplier (http://api.3plcentral.com/rels/customers/supplier)
Resource:
customer supplier
C# Rel Const:
Rels.CustomerSvc.Supplier
URI template:
{id}/suppliers/{sid}
Obtain URI from:
Get a single supplier for this customer
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) Data Type Description
id * int customer id
sid * int supplier 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
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
}
Update a supplier
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
sid * int supplier 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
}
Delete a supplier
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int customer id
sid * int supplier 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.