REL documentation
Resource:contact referenced on a customer's orders or with customerid setC# Rel Const:Rels.CustomerSvc.OrderContactURI template:{id}/ordercontacts/{ocid}Obtain URI from:
Get a single order-related contact for this customer
Success status: 200; ETag response header supplied; Response is cacheable
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| ocid * | int | order contact 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 | ||
| 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
}
Update an order contact
If-Match request header required; Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| ocid * | int | order contact 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
}
Delete an order contact
If-Match request header required; Success status: 204
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| ocid * | int | order contact 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.