Getting Started:
Command Line Interface:
Python Library:
TokenStorage
TokenStorage.identity_url
TokenStorage.expired
TokenStorage.get_token()
TokenStorage.set_token()
TokenStorage.refresh_token()
FileTokenStorage
FileTokenStorage.__init__()
FileTokenStorage.get_token()
FileTokenStorage.set_token()
FileTokenStorage.refresh_token()
SessionTokenStorage
SessionTokenStorage.__init__()
SessionTokenStorage.get_token()
SessionTokenStorage.set_token()
SessionTokenStorage.refresh_token()
ABConnectAPI
ABConnectAPI.models
ABConnectAPI.env
ABConnectAPI.env_file
ABConnectAPI.__init__()
SwaggerParser
SwaggerParser.__init__()
SwaggerParser.parse()
SwaggerParser.resolve_ref()
SwaggerParser.get_endpoints()
SwaggerParser.parse_by_tags()
SwaggerParser.get_schemas()
SwaggerParser.get_endpoint_by_operation_id()
EndpointDefinition
EndpointDefinition.path
EndpointDefinition.method
EndpointDefinition.operation_id
EndpointDefinition.summary
EndpointDefinition.description
EndpointDefinition.tags
EndpointDefinition.parameters
EndpointDefinition.request_body
EndpointDefinition.responses
EndpointDefinition.deprecated
EndpointDefinition.resource_name
EndpointDefinition.method_name
EndpointDefinition.get_path_parameters()
EndpointDefinition.get_query_parameters()
EndpointDefinition.__init__()
ABConnectBaseModel
ABConnectBaseModel.__repr__()
ABConnectBaseModel.check()
ABConnectBaseModel.json()
ABConnectBaseModel.model_config
IdentifiedModel
IdentifiedModel.model_config
IdentifiedModel.id
TimestampedModel
TimestampedModel.model_config
TimestampedModel.created_date
TimestampedModel.modified_date
TimestampedModel.created_by
TimestampedModel.modified_by
ActiveModel
ActiveModel.model_config
ActiveModel.is_active
CompanyRelatedModel
CompanyRelatedModel.model_config
CompanyRelatedModel.company_id
CompanyRelatedModel.company_name
JobRelatedModel
JobRelatedModel.model_config
JobRelatedModel.job_id
FullAuditModel
FullAuditModel.model_config
CompanyAuditModel
CompanyAuditModel.model_config
JobAuditModel
JobAuditModel.model_config
CarrierAPI
CarrierAPI.UNK
CarrierAPI.LMI
CarrierAPI.FEDEX
CarrierAPI.UPS
CarrierAPI.ROADRUNNER
CarrierAPI.REMOVED
CarrierAPI.DHL
CarrierAPI.MAERSK
CarrierAPI.TEAMWW
CarrierAPI.ESTES
CarrierAPI.FORWARDAIR
CarrierAPI.GLOBALTRANZ
CarrierAPI.FEDEXFREIGHT
CarrierAPI.USPS
CommercialCapabilities
CommercialCapabilities.PARCEL
CommercialCapabilities.SOME_COMMERCIAL
CommercialCapabilities.FULL_COMMERCIAL
CommercialCapabilities.CAN_GET_API_LEADS
CommercialCapabilities.CARD_PAYMENTS
CommercialCapabilities.ACH_PAYMENTS
CommercialCapabilities.PREFER_STOCK_BOXES
CommercialCapabilities.DONT_SUPPORT_CUSTOM_BOXES
CommercialCapabilities.ELABEL_ONLY
CopyMaterialsFrom
CopyMaterialsFrom.NONE
CopyMaterialsFrom.PARENT
CopyMaterialsFrom.CORPORATE
DashboardType
DashboardType.INBOUND
DashboardType.RECENTESTIMATES
DashboardType.INHOUSE
DashboardType.OUTBOUND
DashboardType.LOCALDELIVERIES
DocumentSource
DocumentSource.JOB
DocumentSource.SHIPMENT
DocumentSource.COMPANY
DocumentType
DocumentType.LABEL
DocumentType.USAR
DocumentType.CREDIT_CARD_AUTH
DocumentType.BOL
DocumentType.ELECTRONIC_INVOICE
DocumentType.ITEM_PHOTO
DocumentType.OTHER
DocumentType.MANIFEST
DocumentType.COMMERCIAL_INVOICE
DocumentType.PRO_FORMA_INVOICE
DocumentType.PACKING_LIST
DocumentType.INTERNATIONAL_FORMS
DocumentType.AIR_WAYBILL
DocumentType.TERMS_AND_CONDITIONS
DocumentType.CUSTOMER_QUOTE
DocumentType.PICKUP_RECEIPT
DocumentType.EMAIL_CONTENT
DocumentType.UPS_CONTROL_LOG
DocumentType.DELETED_LABEL
ForgotType
ForgotType.PASSWORD
ForgotType.USERNAME
FormType
FormType.NOBREAKDOWN
FormType.BREAKDOWN
FormType.BLANK
FormType.CUSTOMIZED
GeometryType
GeometryType.UNKNOWN
GeometryType.POLYGON
GeometryType.CIRCLE
HistoryCodeABCState
HistoryCodeABCState.ITR
HistoryCodeABCState.DLY
HistoryCodeABCState.EXC
HistoryCodeABCState.DEC
InheritSettingFrom
InheritSettingFrom.NONE
InheritSettingFrom.PARENT
InheritSettingFrom.CORPORATE
JobAccessLevel
JobAccessLevel.NONE
JobAccessLevel.OWNER
JobAccessLevel.CUSTOMER
JobAccessLevel.PICKUP_AGENT
JobAccessLevel.PACKAGING_AGENT
JobAccessLevel.DELIVERY_AGENT
JobAccessLevel.ALL_AGENTS
JobAccessLevel.AGENTS
JobContactType
JobContactType.CUSTOMER
JobContactType.PICKUPS
JobContactType.DELIVERY
JobType
JobType.NONE
JobType.PICKPACK
JobType.REGULAR
JobType.DELIVERY
KnownFormId
KnownFormId.QUICKSALERECEIPT
KnownFormId.CUSTOMERQUOTE
KnownFormId.CREDITCARDAUTHORIZATION
KnownFormId.UNIVERSALSHIPPINGAGREEMENT
KnownFormId.INVOICE
KnownFormId.BILLOFLADING
KnownFormId.OPERATIONS
KnownFormId.ADDRESSLABEL
KnownFormId.PACKAGINGSPECIFICATIONS
KnownFormId.PACKAGINGLABELS
KnownFormId.PACKINGSLIP
KnownFormId.ITEMLABELS
KnownFormId.VALUE_12
LabelImageType
LabelImageType.PDF
LabelImageType.ZPL
LabelImageType.IMAGE
LabelType
LabelType.LABEL2X4
LabelType.LABEL4X6
LabelType.LABEL4X6DOCTAB
LabelType.LABEL8X11
LabelType.LABEL8X11MIRAMAR
LabelType.LABEL8X11TTC
ListSortDirection
ListSortDirection.ASC
ListSortDirection.DESC
OperationsFormType
OperationsFormType.DEFAULT
OperationsFormType.WITHNOTES
PaymentType
PaymentType.PREPAID
PaymentType.THIRDPARTY
PaymentType.COLLECT
PropertyType
PropertyType.RESIDENCE
PropertyType.LIMITED_ACCESS
PropertyType.COMMERCIAL
QuoteRequestStatus
QuoteRequestStatus.DRAFT
QuoteRequestStatus.REQUESTED
QuoteRequestStatus.RESPONSERECEIVED
QuoteRequestStatus.BIDRECEIVED
QuoteRequestStatus.DECLINED
QuoteRequestStatus.SELECTED
QuoteRequestStatus.CANCELLED
QuoteRequestStatus.INSTAQUOTED
RangeDateEnum
RangeDateEnum.DAY
RangeDateEnum.WEEK
RangeDateEnum.MONTH
RangeDateEnum.QUARTER
RangeDateEnum.YEAR
RetransTimeZoneEnum
RetransTimeZoneEnum.ET
RetransTimeZoneEnum.CT
RetransTimeZoneEnum.MT
RetransTimeZoneEnum.PT
SelectedOption
SelectedOption.NONE
SelectedOption.OPTION100
SelectedOption.OPTION500
SelectedOption.OPTION750
SelectedOption.OPTION1500
SendEmailStatus
SendEmailStatus.UNKNOWN
SendEmailStatus.SENT
SendEmailStatus.QUEUED
SendEmailStatus.REJECTED
SendEmailStatus.INVALID
SendEmailStatus.SCHEDULED
SendEmailStatus.BOUNCED
SendEmailStatus.DEFFERED
SendEmailStatus.SOFTBOUNCED
SendEmailStatus.SPAM
SendEmailStatus.UNSUB
ServiceType
ServiceType.UNDEFINED
ServiceType.PICK
ServiceType.PACK
ServiceType.PICKANDPACK
ServiceType.DELIVERY
SortByField
SortByField.JobDisplayID
SortByField.JobMgmtId
SortByField.CompletedDate
SortByField.ContactFirstName
SortByField.ContactFullName
SortByField.EstimateDate
SortByField.QuoteDate
SortByField.PUAddress1
SortByField.DelAddress1
SortByField.ContactLastName
SortByField.Name
SortByField.CreateDate
SortByField.NoteImportant
SortByField.NoteCategory
SortByField.NoteDate
SortByField.NoteDueDate
SortByField.NoteComment
SortByField.NoteAuthor
SortByField.NoteCompleted
SortByField.NoteGlobal
SortByField.NoteShared
SortByField.CompanyName
SortByField.City
SortByField.IndustryType
SortByField.ContactPhone
SortByField.ContactEmail
SortByField.JobNumber
SortByField.Franchisee
SortByField.InsuranceType
SortByField.NoOfPiece
SortByField.TotalValue
SortByField.JobDate
SortByField.INSURANCECOST
SortByField.CARRIER
SortByField.INACCTDATE
SortByField.JobID
SortByField.Company
SortByField.BookedDate
SortByField.Revenue
SortByField.Profit
SortByField.GrossMargin
SortByField.Status
SortByField.Industry
SortByField.CustomerZipCode
SortByField.ReferredBy
SortByField.ReferredName
SortByField.ReferedByCategory
SortByField.Type
SortByField.IntactStatus
SortByField.LeadDate
SortByField.ReferrerPage
SortByField.EntryURL
SortByField.SubmissionPage
SortByField.HowHeard
SortByField.Email
SortByField.Phone
SortByField.ShipFrom
SortByField.ShipTo
SortByField.CustomerComments
SortByField.CurrentBookPrice
SortByField.CurrentBookProfit
SortByField.FranchiseeID
SortByField.IntacctDate
SortByField.Jobtype
SortByField.CreatedByUserName
StatusEnum
StatusEnum.Estimate
StatusEnum.Booked
StatusEnum.Quoted
StatusEnum.Completed
StatusEnum.TemplateJob
StatusEnum.Cancelled
StatusEnum.NotViewed
rebuild_models()
__getattr__()
ABConnectError
ABConnectError.__init__()
ABConnectError.no_traceback()
ABConnectError.to_dict()
RequestError
RequestError.__init__()
NotLoggedInError
NotLoggedInError.__init__()
LoginFailedError
LoginFailedError.__init__()
APIRequestBuilder
APIRequestBuilder.__init__()
APIRequestBuilder.load()
APIRequestBuilder.update()
APIRequestBuilder.build()
FileLoader
FileLoader.file_path
FileLoader.key
FileLoader.data
FileLoader.__init__()
FileLoader.load()
FileLoader.to_list()
FileLoader.to_dict()
Quoter
Quoter.__init__()
Quoter.load_request()
Quoter.call_quoter()
Quoter.parse_qr_response()
Quoter.parse_qq_response()
Quoter.parse_response()
Quoter.book()
Quoter.cleanup()
Quoter.run()
Quoter.get_quote_summary()
RequestHandler
RequestHandler.__init__()
RequestHandler.call()
RequestHandler.raise_for_status()
RequestHandler.upload_file()
Parameter
Parameter.__init__()
Parameter.default
Parameter.description
Parameter.python_name
Parameter.python_type
Parameter.required
Parameter.name
Parameter.location
Parameter.schema
API Documentation:
CompanyDetails
BaseContactDetails
BaseContactDetails.contact_display_id
BaseContactDetails.contact_name
BaseContactDetails.job_title
BaseContactDetails.co_name
BaseContactDetails.bol_note
BaseContactDetails.contact_tax_id
BaseContactDetails.company_display_id
BaseContactDetails.company_type
BaseContactDetails.company_inductry
BaseContactDetails.company_tax_id
BaseContactDetails.company_payer_name
BaseContactDetails.company_address1
BaseContactDetails.company_address2
BaseContactDetails.company_city
BaseContactDetails.company_state
BaseContactDetails.company_country
BaseContactDetails.company_zip_code
BaseContactDetails.company_latitude
BaseContactDetails.company_longitude
BaseContactDetails.model_config
CalendarContact
CalendarContact.contact_display_id
CalendarContact.company_id
CalendarContact.company_name
CalendarContact.bol_notes
CalendarContact.full_name
CalendarContact.model_config
Contact
Contact.company_id
Contact.address_id
Contact.address1
Contact.address2
Contact.city
Contact.state
Contact.state_code
Contact.country_name
Contact.country_code
Contact.country_id
Contact.zip_code
Contact.is_active
Contact.latitude
Contact.longitude
Contact.result
Contact.address_mapping_id
Contact.contact_id
Contact.primary_customer_name
Contact.contact_info
Contact.address
Contact.parent_company_id
Contact.user_id
Contact.payer_id
Contact.cust_companyid
Contact.pu_business_status
Contact.del_business_status
Contact.pu_zone
Contact.new_contact_id
Contact.contact_is_business
Contact.contact_first_name
Contact.contact_last_name
Contact.contact_full_name
Contact.contact_phone
Contact.contact_fax
Contact.customer_cell
Contact.contact_email_id
Contact.contact_type_id
Contact.refer_id
Contact.referred_name
Contact.contact_dept
Contact.contact_assistant
Contact.contact_assistant_phone
Contact.contact_home_phone
Contact.contact_birth_date
Contact.is_primary
Contact.is_prefered
Contact.referred_by
Contact.is_payer
Contact.payer_name
Contact.other_referral
Contact.master_constant_id
Contact.company_name
Contact.parent_company_name
Contact.company_code
Contact.master_constant_value
Contact.total_record
Contact.industry_type
Contact.contact_address
Contact.contact_user
Contact.total_items
Contact.contact_web_site
Contact.is_global
Contact.user_name
Contact.is_access
Contact.contact_display_id
Contact.company_display_id
Contact.franchisee_name
Contact.contact_type
Contact.created_user
Contact.mapping_locations
Contact.location_count
Contact.base_parent
Contact.model_config
ContactAddressDetails
ContactAddressDetails.is_active
ContactAddressDetails.deactivated_reason
ContactAddressDetails.meta_data
ContactAddressDetails.address
ContactAddressDetails.model_config
ContactAddressEditDetails
ContactAddressEditDetails.editable
ContactAddressEditDetails.detail_hash
ContactAddressEditDetails.model_config
ContactDetailedInfo
ContactDetailedInfo.contact_display_id
ContactDetailedInfo.full_name
ContactDetailedInfo.contact_type_id
ContactDetailedInfo.care_of
ContactDetailedInfo.bol_notes
ContactDetailedInfo.tax_id
ContactDetailedInfo.is_business
ContactDetailedInfo.is_payer
ContactDetailedInfo.is_prefered
ContactDetailedInfo.is_private
ContactDetailedInfo.is_active
ContactDetailedInfo.company_id
ContactDetailedInfo.root_contact_id
ContactDetailedInfo.owner_franchisee_id
ContactDetailedInfo.company
ContactDetailedInfo.legacy_guid
ContactDetailedInfo.is_primary
ContactDetailedInfo.assistant
ContactDetailedInfo.department
ContactDetailedInfo.web_site
ContactDetailedInfo.birth_date
ContactDetailedInfo.job_title_id
ContactDetailedInfo.job_title
ContactDetailedInfo.emails_list
ContactDetailedInfo.phones_list
ContactDetailedInfo.addresses_list
ContactDetailedInfo.fax
ContactDetailedInfo.primary_phone_detail
ContactDetailedInfo.primary_phone
ContactDetailedInfo.primary_email_detail
ContactDetailedInfo.primary_email
ContactDetailedInfo.primary_address_detail
ContactDetailedInfo.editable
ContactDetailedInfo.contact_details_company_info
ContactDetailedInfo.model_config
ContactDetails
ContactDetails.contact_display_id
ContactDetails.full_name
ContactDetails.contact_type_id
ContactDetails.care_of
ContactDetails.bol_notes
ContactDetails.tax_id
ContactDetails.is_business
ContactDetails.is_payer
ContactDetails.is_prefered
ContactDetails.is_private
ContactDetails.is_active
ContactDetails.company_id
ContactDetails.root_contact_id
ContactDetails.owner_franchisee_id
ContactDetails.company
ContactDetails.legacy_guid
ContactDetails.is_primary
ContactDetails.assistant
ContactDetails.department
ContactDetails.web_site
ContactDetails.birth_date
ContactDetails.job_title_id
ContactDetails.job_title
ContactDetails.emails_list
ContactDetails.phones_list
ContactDetails.addresses_list
ContactDetails.fax
ContactDetails.primary_phone_detail
ContactDetails.primary_phone
ContactDetails.primary_email_detail
ContactDetails.primary_email
ContactDetails.primary_address_detail
ContactDetails.editable
ContactDetails.is_empty
ContactDetails.full_name_update_required
ContactDetails.model_config
ContactEmailDetails
ContactEmailDetails.is_active
ContactEmailDetails.deactivated_reason
ContactEmailDetails.meta_data
ContactEmailDetails.email
ContactEmailDetails.model_config
ContactEmailEditDetails
ContactEmailEditDetails.editable
ContactEmailEditDetails.detail_hash
ContactEmailEditDetails.model_config
ContactHistoryPricePerPound
ContactHistoryPricePerPound.weight
ContactHistoryPricePerPound.amount
ContactHistoryPricePerPound.job_type
ContactHistoryPricePerPound.booked_or_completed
ContactHistoryPricePerPound.model_config
ContactHistoryRevenueSum
ContactHistoryRevenueSum.created_date_str_internal
ContactHistoryRevenueSum.booked_completed_revenue
ContactHistoryRevenueSum.quoted_estimate_revenue
ContactHistoryRevenueSum.booked_completed_job_count
ContactHistoryRevenueSum.quoted_estimate_job_count
ContactHistoryRevenueSum.model_config
ContactPhoneDetails
ContactPhoneDetails.is_active
ContactPhoneDetails.deactivated_reason
ContactPhoneDetails.meta_data
ContactPhoneDetails.phone
ContactPhoneDetails.model_config
ContactPhoneEditDetails
ContactPhoneEditDetails.editable
ContactPhoneEditDetails.detail_hash
ContactPhoneEditDetails.model_config
ContactPrimaryDetails
ContactPrimaryDetails.full_name
ContactPrimaryDetails.email
ContactPrimaryDetails.phone
ContactPrimaryDetails.cell_phone
ContactPrimaryDetails.fax
ContactPrimaryDetails.address
ContactPrimaryDetails.company
ContactPrimaryDetails.model_config
ContactUser
ContactUser.full_name
ContactUser.company_id
ContactUser.company_name
ContactUser.model_config
MergeContactsSearchRequestModel
MergeContactsSearchRequestModel.main_search_request
MergeContactsSearchRequestModel.load_options
MergeContactsSearchRequestModel.model_config
MergeContactsSearchRequestParameters
MergeContactsSearchRequestParameters.contact_display_id
MergeContactsSearchRequestParameters.full_name
MergeContactsSearchRequestParameters.company_code
MergeContactsSearchRequestParameters.email
MergeContactsSearchRequestParameters.phone
MergeContactsSearchRequestParameters.company_display_id
MergeContactsSearchRequestParameters.model_config
PlannerContact
PlannerContact.full_name
PlannerContact.company_name
PlannerContact.model_config
SearchContactEntityResult
SearchContactEntityResult.contact_id
SearchContactEntityResult.customer_cell
SearchContactEntityResult.contact_display_id
SearchContactEntityResult.contact_full_name
SearchContactEntityResult.contact_phone
SearchContactEntityResult.contact_home_phone
SearchContactEntityResult.contact_email
SearchContactEntityResult.master_constant_value
SearchContactEntityResult.contact_dept
SearchContactEntityResult.address1
SearchContactEntityResult.address2
SearchContactEntityResult.city
SearchContactEntityResult.state
SearchContactEntityResult.zip_code
SearchContactEntityResult.country_name
SearchContactEntityResult.company_code
SearchContactEntityResult.company_display_id
SearchContactEntityResult.is_prefered
SearchContactEntityResult.industry_type
SearchContactEntityResult.total_records
SearchContactEntityResult.model_config
SearchContactRequest
SearchContactRequest.page_index
SearchContactRequest.page_size
SearchContactRequest.total_count
SearchContactRequest.sorting_by
SearchContactRequest.sorting_direction
SearchContactRequest.full_name
SearchContactRequest.company_display_id
SearchContactRequest.contact_display_id
SearchContactRequest.company_code
SearchContactRequest.email
SearchContactRequest.phone
SearchContactRequest.city
SearchContactRequest.state
SearchContactRequest.zip_code
SearchContactRequest.user_id
SearchContactRequest.type
SearchContactRequest.model_config
ShipmentContactAddressDetails
ShipmentContactAddressDetails.contact_name
ShipmentContactAddressDetails.phone_number
ShipmentContactAddressDetails.email_address
ShipmentContactAddressDetails.address
ShipmentContactAddressDetails.tax_ids
ShipmentContactAddressDetails.model_config
ShipmentContactDetails
ShipmentContactDetails.contact_name
ShipmentContactDetails.phone_number
ShipmentContactDetails.email_address
ShipmentContactDetails.tax_id
ShipmentContactDetails.address
ShipmentContactDetails.is_empty
ShipmentContactDetails.model_config
DocumentUpdateModel
DocumentUpdateModel.file_name
DocumentUpdateModel.type_id
DocumentUpdateModel.shared
DocumentUpdateModel.tags
DocumentUpdateModel.job_items
DocumentUpdateModel.model_config
CreateUserModel
CreateUserModel.login
CreateUserModel.contact_id
CreateUserModel.full_name
CreateUserModel.email
CreateUserModel.email_confirmed
CreateUserModel.password
CreateUserModel.lockout_date_utc
CreateUserModel.lockout_enabled
CreateUserModel.company_id
CreateUserModel.role
CreateUserModel.model_config
PocUser
PocUser.id
PocUser.name
PocUser.model_config
UserInfo
UserInfo.login
UserInfo.full_name
UserInfo.contact_id
UserInfo.contact_display_id
UserInfo.contact_company_name
UserInfo.contact_company_id
UserInfo.contact_company_display_id
UserInfo.email
UserInfo.email_confirmed
UserInfo.contact_phone
UserInfo.contact_email
UserInfo.password
UserInfo.lockout_date_utc
UserInfo.lockout_enabled
UserInfo.role
UserInfo.is_active
UserInfo.legacy_id
UserInfo.additional_user_companies
UserInfo.additional_user_companies_names
UserInfo.crm_contact_id
UserInfo.model_config
Users
Users.row_id
Users.total_rows
Users.user_name
Users.password
Users.user_expiration_date
Users.dashboard_user_id
Users.company_id
Users.has_access
Users.is_active
Users.dashboard_id
Users.results
Users.role_id
Users.user_company_id
Users.company_type
Users.corporate_company_id
Users.usersystem_log_id
Users.ip_address
Users.user_id
Users.login_time
Users.logout_time
Users.create_by
Users.company_name
Users.company_code
Users.name
Users.from_date
Users.to_date
Users.sorting_direction
Users.sorting_by
Users.page_size
Users.page_number
Users.country_name
Users.pricing_to_use
Users.parent_company_id
Users.crm_contact_id
Users.model_config
Reference: