properties carrieraccountsmappings (http://api.3plcentral.com/rels/properties/carrieraccountsmappings)
Resource:
Collection: carrier account mapping in parcelapi
C# Rel Const:
Rels.PropertySvc.CarrierAccountMappings
URI template:
carrieraccounts/mappings/{provider}
Obtain URI from:
This method will retrieve the carrier accounts mapped in the ParcelApi.
Success status: 200
Name (* = required) Data Type Description
provider * string
Type Description
InvoiceDate DateTime? ...
InvoiceAmount Double? ...
AgreeToEula bool? ...
EnableNegotiatedRates bool? ...
IsPrimaryAccount bool? ...
InvoiceReceivedInPast90Days bool? ...
ShouldHideAccountNumberOnArchiveDoc bool? ...
UseCarbonNeutralShippingProgram bool? ...
UseConsolidationServices bool? ...
UseGroundFreightPricing bool? ...
UseNegotiatedRates bool? ...
UseOrderNumberOnMailInnovationsLabels bool? ...
MinimalAddressValidation bool? ...
AttrAlcohol bool? ...
AttrDryIce bool? ...
AttrHazMat bool? ...
AttrTwoPersons bool? ...
AttrExplosive bool? ...
AttrControlledSubstance bool? ...
AttrRefrigerated bool? ...
AttrPerishable bool? ...
AttrNorts bool? ...
AccountCountryCode string
AccountNumber string
AccountPostalCode string
Address1 string
Address2 string
AccessKey string
ApiKey string
ApiSecret string
ApiToken string
CarrierCustomerGuid string
CarrierCustomerId string
CarrierName string
City string
ClientId string
Company string
ContactName string
ContactTitle string
ContractId string
ControlId string
CountryCode string
DistributionCenter string
Email string
FirstName string
InvoiceNumber string
LastName string
MailerId string
MailInnovationsCostCenter string
MailInnovationsEndorsement string
Nickname string
Passphrase string
Password string
Phone string
PickupNumber string
PickupType string
PostalCode string
ShipEngineId string
SmartPostEndorsement string
SmartPostHub string
State string
Username string
Provider string
OrganizationNumber string
ConnectToken string
ClientFacilityId string
CarrierFacilityId string
CarrierGatewayFacilityId string
DispositionRulesetId string
ReturnClientId string
NonDeliveryDefault string
HubLocation string
ShipperRatePlan string
IntegratorCarrierId string
CBDSHub string
CBDSDeliverySolution string
HubId string
UserId string
ShipmentType string
CarrierJsonObj string
WebServicesId string
WebServicesKey string
CustomerBranch string
InjectionLocation string
MailInnovationsCustomerId string
MailInnovationsCustomerGuid string
AncillaryEndorsement string
CriticalPullTime string
CriticalEntryTime string
AuthUrl string
SyncWithProvider string
Sample accept: application/hal+json
{
  "invoiceDate": "2016-12-25T23:00:00",
  "invoiceAmount": 1.1,
  "agreeToEula": true,
  "enableNegotiatedRates": true,
  "isPrimaryAccount": true,
  "invoiceReceivedInPast90Days": true,
  "shouldHideAccountNumberOnArchiveDoc": true,
  "useCarbonNeutralShippingProgram": true,
  "useConsolidationServices": true,
  "useGroundFreightPricing": true,
  "useNegotiatedRates": true,
  "useOrderNumberOnMailInnovationsLabels": true,
  "minimalAddressValidation": true,
  "attrAlcohol": true,
  "attrDryIce": true,
  "attrHazMat": true,
  "attrTwoPersons": true,
  "attrExplosive": true,
  "attrControlledSubstance": true,
  "attrRefrigerated": true,
  "attrPerishable": true,
  "attrNorts": true,
  "accountCountryCode": "str",
  "accountNumber": "str",
  "accountPostalCode": "str",
  "address1": "str",
  "address2": "str",
  "accessKey": "str",
  "apiKey": "str",
  "apiSecret": "str",
  "apiToken": "str",
  "carrierCustomerGuid": "str",
  "carrierCustomerId": "str",
  "carrierName": "str",
  "city": "str",
  "clientId": "str",
  "company": "str",
  "contactName": "str",
  "contactTitle": "str",
  "contractId": "str",
  "controlId": "str",
  "countryCode": "str",
  "distributionCenter": "str",
  "email": "str",
  "firstName": "str",
  "invoiceNumber": "str",
  "lastName": "str",
  "mailerId": "str",
  "mailInnovationsCostCenter": "str",
  "mailInnovationsEndorsement": "str",
  "nickname": "str",
  "passphrase": "str",
  "password": "str",
  "phone": "str",
  "pickupNumber": "str",
  "pickupType": "str",
  "postalCode": "str",
  "shipEngineId": "str",
  "smartPostEndorsement": "str",
  "smartPostHub": "str",
  "state": "str",
  "username": "str",
  "provider": "str",
  "organizationNumber": "str",
  "connectToken": "str",
  "clientFacilityId": "str",
  "carrierFacilityId": "str",
  "carrierGatewayFacilityId": "str",
  "dispositionRulesetId": "str",
  "returnClientId": "str",
  "nonDeliveryDefault": "str",
  "hubLocation": "str",
  "shipperRatePlan": "str",
  "integratorCarrierId": "str",
  "cbdsHub": "str",
  "cbdsDeliverySolution": "str",
  "hubId": "str",
  "userId": "str",
  "shipmentType": "str",
  "carrierJsonObj": "str",
  "webServicesId": "str",
  "webServicesKey": "str",
  "customerBranch": "str",
  "injectionLocation": "str",
  "mailInnovationsCustomerId": "str",
  "mailInnovationsCustomerGuid": "str",
  "ancillaryEndorsement": "str",
  "criticalPullTime": "str",
  "criticalEntryTime": "str",
  "authUrl": "str",
  "syncWithProvider": "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.