REL documentation
customers customercarrieraccounts (http://api.3plcentral.com/rels/customers/customercarrieraccounts)
Resource:
Collection: of customercarrieraccount
C# Rel Const:
Rels.CustomerSvc.CustomerCarrierAccounts
URI template:
{id}/carrieraccounts
Obtain URI from:
/rels/customers/customer
Success status: 200
Name (* = required) Data Type Description
id * int
Type Description
CustomerCarrierAccountId int
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
Carrier string
AccountNumber string
AccountZip string
AccountOverride bool
Nickname string
ShipEngineId string
Provider string
Sample content-type: application/hal+json
 
{
  "customerCarrierAccountId": 1,
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "carrier": "str",
  "accountNumber": "str",
  "accountZip": "str",
  "accountOverride": true,
  "nickname": "str",
  "shipEngineId": "str",
  "provider": "str"
}
Type Description
CustomerCarrierAccountId int
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
Carrier string
AccountNumber string
AccountZip string
AccountOverride bool
Nickname string
ShipEngineId string
Provider string
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "customerCarrierAccountId": 1,
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "carrier": "str",
  "accountNumber": "str",
  "accountZip": "str",
  "accountOverride": true,
  "nickname": "str",
  "shipEngineId": "str",
  "provider": "str"
}
Success status: 200
Name (* = required) Data Type Description
id * int
Type Description
ResourceList IList<Customer.Models.CustomerCarrierAccount>
CustomerCarrierAccountId int
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
Carrier string
AccountNumber string
AccountZip string
AccountOverride bool
Nickname string
ShipEngineId string
Provider string
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/customercarrieraccount": [
      {
        "customerCarrierAccountId": 1,
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "carrier": "str",
        "accountNumber": "str",
        "accountZip": "str",
        "accountOverride": true,
        "nickname": "str",
        "shipEngineId": "str",
        "provider": "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.