Rel doc - Rel

GET

/customers/{id}/ordercontacts{?usedAs,minUsed,lastUsed,pgsiz,pgnum,rql,sort}

Get a list of contacts related to this customer's orders
Success status: 200

Params
Response body (Customer.Models.OrderContactList)

Name (* = required)	Data Type	Description
id *	int	customer id
usedAs *	Common.Enum.ContactType
	- ShipTo
	- SoldTo
	- BillTo
minUsed	int	minimum number of times a given contact appears on this customer's orders
lastUsed	int	largest number of days since a given contact appears on this customer's orders
pgsiz	int	must be positive; limit 100, specifying more is an error; default 0; 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.OrderContact>
OrderContactId	int
CompanyName	string
Name	string
Title	string
Address1	string
Address2	string
City	string
State	string
Zip	string
Country	string
PhoneNumber	string
Fax	string
EmailAddress	string
Dept	string
IsQuickLookup	bool
RetailerId	int? ...
ContactType	Common.Enum.ContactType? ...
	- 0: ShipTo
	- 1: SoldTo
	- 2: BillTo
Code	string
Bill3rdPartyAccount	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/ordercontact": [
      {
        "orderContactId": 1,
        "companyName": "str",
        "name": "str",
        "title": "str",
        "address1": "str",
        "address2": "str",
        "city": "str",
        "state": "str",
        "zip": "str",
        "country": "str",
        "phoneNumber": "str",
        "fax": "str",
        "emailAddress": "str",
        "dept": "str",
        "isQuickLookup": true,
        "retailerId": 1,
        "contactType": 0,
        "code": "str",
        "bill3rdPartyAccount": "str",
        "addressStatus": 0
      }
    ]
  }
}

POST

/customers/{id}/ordercontacts

Create an order contact
Success status: 201; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int	customer id

	Type	Description
OrderContactId	int
CompanyName	string
Name	string
Title	string
Address1	string
Address2	string
City	string
State	string
Zip	string
Country	string
PhoneNumber	string
Fax	string
EmailAddress	string
Dept	string
IsQuickLookup	bool
RetailerId	int? ...
ContactType	Common.Enum.ContactType? ...
	- 0: ShipTo
	- 1: SoldTo
	- 2: BillTo
Code	string
Bill3rdPartyAccount	string
AddressStatus	Common.Enum.AddressStatusType	confirmation status
	- 0: Unconfirmed
	- 1: Confirmed
	- 2: UserAccepted

Sample content-type: application/hal+json

{
  "orderContactId": 1,
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isQuickLookup": true,
  "retailerId": 1,
  "contactType": 0,
  "code": "str",
  "bill3rdPartyAccount": "str",
  "addressStatus": 0
}

	Type	Description
OrderContactId	int
CompanyName	string
Name	string
Title	string
Address1	string
Address2	string
City	string
State	string
Zip	string
Country	string
PhoneNumber	string
Fax	string
EmailAddress	string
Dept	string
IsQuickLookup	bool
RetailerId	int? ...
ContactType	Common.Enum.ContactType? ...
	- 0: ShipTo
	- 1: SoldTo
	- 2: BillTo
Code	string
Bill3rdPartyAccount	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

{
  "orderContactId": 1,
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isQuickLookup": true,
  "retailerId": 1,
  "contactType": 0,
  "code": "str",
  "bill3rdPartyAccount": "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.