Type	Description
ConnectionString	string	non-null sets/resets the existing ConnectionString; null leaves connection string as is
Active	bool? ...	True means set to active status; False means set to inactive status; null leaves existing status as is

Sample content-type: application/hal+json

Copy to clipboard

copied

{
  "connectionString": "str",
  "active": true
}

	Type	Description
ReadOnly	Generic.Models.ThreePlReadOnly
ThreePlId	int
GuId	string
Status	Common.Enum.ThreePlRecordStatus
	- 0: NewRecord
	- 1: ConfEmailSent
	- 2: ReadyToCreateDb
	- 3: DbCreated
	- 4: Deactivated
CreationDate	DateTime? ...
BillingHold	bool
IsPrivateWarehouse	bool
UseCognitoLogin	bool
CompanyInfo	Generic.Models.ContactInfo	in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId	int? ...	for identifying: if known specify only this; other fields are ignored
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
IsAddressResidential	bool
Code	string	for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus	Common.Enum.AddressStatusType	confirmation status
	- 0: Unconfirmed
	- 1: Confirmed
	- 2: UserAccepted
BrandingFileName	string
RecurringBillingId	string
WebSite	string
DandBNum	string
FederalId	string
Login	string	Used for POST; not returned by GET
Password	string	Used for POST; not returned by GET
Contact1	Generic.Models.ThreePlContactInfo
Cell	string
ContactId	int? ...	for identifying: if known specify only this; other fields are ignored
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
IsAddressResidential	bool
Code	string	for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus	Common.Enum.AddressStatusType	confirmation status
	- 0: Unconfirmed
	- 1: Confirmed
	- 2: UserAccepted
Contact2	Generic.Models.ThreePlContactInfo
Cell	string
ContactId	int? ...	for identifying: if known specify only this; other fields are ignored
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
IsAddressResidential	bool
Code	string	for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus	Common.Enum.AddressStatusType	confirmation status
	- 0: Unconfirmed
	- 1: Confirmed
	- 2: UserAccepted
Options	Generic.Models.ThreePlOptions
Integrations	Generic.Models.Integrations
QbEnabled	Common.Enum.QbEnabled
	- 0: Off
	- 1: Desktop
	- 2: Online
QbOnlineCanadianTax	bool	controls whether 3 tax-related entry boxes are visible when setting up transaction and storage charge rates
UpsLogin	string
UpsPassword	string
UpsMode	Common.Enum.UpsMode
	- 0: Test
	- 1: Production
UpsAccessKey	string
FedExAccessKey	string
EdiEnabled	bool
OtherCarrierExportEnabled	bool
ExternalRateNegotiatorEnabled	bool
ExternalRateNegotiatorDefaultWeightClass	decimal
AllowSpsWsCalls	bool
UspsEnabled	bool
SmallParcelPartner	string
TmwExportEnabled	bool
WebHookParameters	IEnumerable<Generic.Models.WebHookParametersForEvents>	Web Hook configuration at the ThreePl (C1) level
Name	string
Resource	string	Domain: Order, Receiver, Adjustment, Assembly, OrderItem, Item, InventorySummary
EventTypes	string	a comma-delimited list of supported event types; must be within 'Resource', e.g., if the Resource is 'Order", all EventTypes must be Orderxxx
Url	string
IncludeResource	bool
ResourceApiParameters	string	as defined in the REL documentation for the Resource
SalesforceId	string
UseBillingManager	bool
WebhooksEnabled	bool
UserInterface	Generic.Models.UserInterface
DefaultOrderPage	string
DefaultReceivePage	string
Show3PlCentral	bool
LogoId	int
ThemeName	string
HideHelpVideos	bool
DefaultBrandingImage	int
ShowCycleCountMenuInV1	bool
ConnectionsEnabled	bool
ExternalLogger	bool
UxPrototypingDirectives	string
PreventClassicAccess	bool
EditableOptions	string	set by salesforce as a comma-delim list of option prop names the user is allowed to modify in SV TPL options page
FindOrdersAutoBatchEnabled	bool
Email	Generic.Models.Email
EmailFrom	string
SenderName	string
ReplyToAddress	string
AttachedDocsEmailEnabled	bool
Items	Generic.Models.Items
HazMatEnabled	bool
PricingEnabled	bool
ItemClassificationEnabled	bool
ItemImagesEnabled	bool
SkuAliasEnabled	bool
Receiving	Generic.Models.Receiving
PalletsEnabled	bool
AllowReceiveAgainstAsn	bool
AutoReallocOnReceiveEnabled	bool
SuggestedPutAwayEnabled	bool
AllowPurchaseOrders	bool
SpsCloseOnUpdate	bool
AllowUnconfirmReceiver	bool
ConsolidateAsnEnabled	bool
AutoSetArrivalDate	bool
TrackBysEditEnabled	bool
DirectedPutAwayEnabled	bool
Shipping	Generic.Models.Shipping
AllowOrderQueue	bool
WarehousePackEnabled	bool
FulfillInvEnabled	bool
AllowCustomPackingLists	bool
MobilePalletLoadOutEnabled	bool
ShortShipEnabled	bool
AutoBillEnabled	bool
AutoBillLogRetentionDays	int
AttachedDocsEnabled	bool
SmallParcelEnabled	bool
SmallParcelEula	string
SmallParcelZPLPrintDefault	bool
CustomPickEnabled	bool
BillToEnabled	bool
FindOrderSkuSearchEnabled	bool
OutboundMobileSerializationEnabled	bool
PrintOverAllocPickTickets	bool
ExternalSoapOverAllocatedCheckOnCreateOrder	bool
SmallParcelReturnLabelEnabled	bool
SmallParcelHighVolumeProcessing	bool
SmallParcelShipEngineHighVolumeBatches	bool
SmallParcelPackageSplit	int
UseShipMethodMappings	bool
IntegratedLabelEnabled	bool
IntegratedLabelSplit	int
SmartPackScaleEnabled	bool
AliasOverAllocateCheckOnImport	bool
ZoneBillingEnabled	bool
SmallParcelCreatePackagesOnFind	bool
SmallParcelMultipleAccounts	bool
SmallParcelRateShoppingEnabled	bool
SmallParcelInjectLabelEnabled	bool
AutoBatchEnabled	bool
GlobalRecipient	string
SmallParcelIncludeMediaMail	bool
SmallParcelAccountMarkups	bool
OtherUserFeatures	Generic.Models.OtherUserFeatures
SavedElementsEnabled	bool
MobileEnabled	bool
OverrideDoor	bool
OverrideTrailer	bool
DashboardEnabled	bool
ReallocateAtPickTimeEnabled	bool
StockStatusExportEnabled	bool
PeriodicReportExportEnabled	bool
CustomerItemMarkupEnabled	bool
AllowAllocatedStockMoveEnabled	bool
AddressValidationEnabled	bool
ErpEnabled	bool
ErpAdditionsEnabled	bool
SemiAutoMonthlyBillingEnable	bool
ShowZeroHandlingCharges	bool
CheckBeforeMassConfirm	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/master/threeplconnection

Sample accept: application/hal+json

{
  "readOnly": {
    "threePlId": 1,
    "guId": "str",
    "status": 0,
    "creationDate": "2016-12-25T23:00:00",
    "billingHold": true,
    "isPrivateWarehouse": true,
    "useCognitoLogin": true
  },
  "companyInfo": {
    "contactId": 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",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "brandingFileName": "str",
  "recurringBillingId": "str",
  "webSite": "str",
  "dandBNum": "str",
  "federalId": "str",
  "login": "str",
  "password": "str",
  "contact1": {
    "cell": "str",
    "contactId": 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",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "contact2": {
    "cell": "str",
    "contactId": 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",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "options": {
    "integrations": {
      "qbEnabled": 0,
      "qbOnlineCanadianTax": true,
      "upsLogin": "str",
      "upsPassword": "str",
      "upsMode": 0,
      "upsAccessKey": "str",
      "fedExAccessKey": "str",
      "ediEnabled": true,
      "otherCarrierExportEnabled": true,
      "externalRateNegotiatorEnabled": true,
      "externalRateNegotiatorDefaultWeightClass": 9.0,
      "allowSpsWsCalls": true,
      "uspsEnabled": true,
      "smallParcelPartner": "str",
      "tmwExportEnabled": true,
      "webHookParameters": [
        {
          "name": "str",
          "resource": "str",
          "eventTypes": "str",
          "url": "str",
          "includeResource": true,
          "resourceApiParameters": "str"
        }
      ],
      "salesforceId": "str",
      "useBillingManager": true,
      "webhooksEnabled": true
    },
    "userInterface": {
      "defaultOrderPage": "str",
      "defaultReceivePage": "str",
      "show3PlCentral": true,
      "logoId": 4,
      "themeName": "str",
      "hideHelpVideos": true,
      "defaultBrandingImage": 7,
      "showCycleCountMenuInV1": true,
      "connectionsEnabled": true,
      "externalLogger": true,
      "uxPrototypingDirectives": "str",
      "preventClassicAccess": true,
      "editableOptions": "str",
      "findOrdersAutoBatchEnabled": true
    },
    "email": {
      "emailFrom": "str",
      "senderName": "str",
      "replyToAddress": "str",
      "attachedDocsEmailEnabled": true
    },
    "items": {
      "hazMatEnabled": true,
      "pricingEnabled": true,
      "itemClassificationEnabled": true,
      "itemImagesEnabled": true,
      "skuAliasEnabled": true
    },
    "receiving": {
      "palletsEnabled": true,
      "allowReceiveAgainstAsn": true,
      "autoReallocOnReceiveEnabled": true,
      "suggestedPutAwayEnabled": true,
      "allowPurchaseOrders": true,
      "spsCloseOnUpdate": true,
      "allowUnconfirmReceiver": true,
      "consolidateAsnEnabled": true,
      "autoSetArrivalDate": true,
      "trackBysEditEnabled": true,
      "directedPutAwayEnabled": true
    },
    "shipping": {
      "allowOrderQueue": true,
      "warehousePackEnabled": true,
      "fulfillInvEnabled": true,
      "allowCustomPackingLists": true,
      "mobilePalletLoadOutEnabled": true,
      "shortShipEnabled": true,
      "autoBillEnabled": true,
      "autoBillLogRetentionDays": 8,
      "attachedDocsEnabled": true,
      "smallParcelEnabled": true,
      "smallParcelEula": "str",
      "smallParcelZPLPrintDefault": true,
      "customPickEnabled": true,
      "billToEnabled": true,
      "findOrderSkuSearchEnabled": true,
      "outboundMobileSerializationEnabled": true,
      "printOverAllocPickTickets": true,
      "externalSoapOverAllocatedCheckOnCreateOrder": true,
      "smallParcelReturnLabelEnabled": true,
      "smallParcelHighVolumeProcessing": true,
      "smallParcelShipEngineHighVolumeBatches": true,
      "smallParcelPackageSplit": 22,
      "useShipMethodMappings": true,
      "integratedLabelEnabled": true,
      "integratedLabelSplit": 25,
      "smartPackScaleEnabled": true,
      "aliasOverAllocateCheckOnImport": true,
      "zoneBillingEnabled": true,
      "smallParcelCreatePackagesOnFind": true,
      "smallParcelMultipleAccounts": true,
      "smallParcelRateShoppingEnabled": true,
      "smallParcelInjectLabelEnabled": true,
      "autoBatchEnabled": true,
      "globalRecipient": "str",
      "smallParcelIncludeMediaMail": true,
      "smallParcelAccountMarkups": true
    },
    "otherUserFeatures": {
      "savedElementsEnabled": true,
      "mobileEnabled": true,
      "overrideDoor": true,
      "overrideTrailer": true,
      "dashboardEnabled": true,
      "reallocateAtPickTimeEnabled": true,
      "stockStatusExportEnabled": true,
      "periodicReportExportEnabled": true,
      "customerItemMarkupEnabled": true,
      "allowAllocatedStockMoveEnabled": true,
      "addressValidationEnabled": true,
      "erpEnabled": true,
      "erpAdditionsEnabled": true,
      "semiAutoMonthlyBillingEnable": true,
      "showZeroHandlingCharges": true,
      "checkBeforeMassConfirm": true
    }
  }
}