Companies

class ab.api.endpoints.companies.CompaniesEndpoint(client, resolver)[source]

Operations on companies (ACPortal API).

Parameters:

client (Any)
resolver (CodeResolver)

get_by_id(company_id)[source]

GET /companies/{id}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_by_id.html Response model: CompanySimple

Parameters:: company_id (str)
Return type:: CompanySimple

get_details(company_id)[source]

GET /companies/{companyId}/details

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_details.html Response model: CompanyDetails

Parameters:: company_id (str)
Return type:: CompanyDetails

get_fulldetails(company_id)[source]

GET /companies/{companyId}/fulldetails

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_fulldetails.html Response model: CompanyDetails

Parameters:: company_id (str)
Return type:: CompanyDetails

update_fulldetails(company_id, *, data)[source]

PUT /companies/{companyId}/fulldetails.

Parameters:

company_id (str) – Company ID or code.
data (CompanyDetails | dict) – Full company details payload. Accepts a CompanyDetails instance or a dict.

Return type:

CompanyDetails

Request model: CompanyDetails

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/update_fulldetails.html Request model: CompanyDetails Response model: CompanyDetails

create(*, data)[source]

POST /companies/fulldetails.

Parameters:: data (CompanyDetails | dict) – Full company details payload. Accepts a CompanyDetails instance or a dict.
Return type:: str

Request model: CompanyDetails

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/create.html Request model: CompanyDetails

search(*, data)[source]

POST /companies/search/v2.

Parameters:: data (CompanySearchRequest | dict) – Search filter with pagination, search text, and filters. Accepts a CompanySearchRequest instance or a dict.
Return type:: list[SearchCompanyResponse]

Request model: CompanySearchRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/search.html Request model: CompanySearchRequest Response model: List[SearchCompanyResponse]

list(*, data)[source]

POST /companies/list.

Parameters:: data (ListRequest | dict) – List filter with pagination, sorting, and filters. Accepts a ListRequest instance or a dict.
Return type:: list[CompanySimple]

Request model: ListRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/list.html Request model: ListRequest Response model: List[CompanySimple]

available_by_current_user()[source]

GET /companies/availableByCurrentUser

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/available_by_current_user.html Response model: List[CompanySimple]

Return type:: list[CompanySimple]

get_brands()[source]

GET /companies/brands

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_brands.html Response model: List[CompanyBrand]

Return type:: list[CompanyBrand]

get_brands_tree()[source]

GET /companies/brandstree

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_brands_tree.html Response model: List[BrandTree]

Return type:: list[BrandTree]

get_geo_area_companies(*, params=None)[source]

GET /companies/geoAreaCompanies.

Parameters:: params (dict | None) – Optional query parameters as a dict.
Return type:: None

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_geo_area_companies.html

get_geo_settings(company_id)[source]

GET /companies/{companyId}/geosettings

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_geo_settings.html Response model: GeoSettings

Parameters:: company_id (str)
Return type:: GeoSettings

save_geo_settings(company_id, *, data)[source]

POST /companies/{companyId}/geosettings.

Parameters:

company_id (str) – Company ID or code.
data (GeoSettingsSaveRequest | dict) – Geo settings payload with service_areas and restrictions. Accepts a GeoSettingsSaveRequest instance or a dict.

Return type:

None

Request model: GeoSettingsSaveRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/save_geo_settings.html Request model: GeoSettingsSaveRequest

get_global_geo_settings()[source]

GET /companies/geosettings

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_global_geo_settings.html Query params: GeoSettingsParams Response model: GeoSettings

Return type:: GeoSettings

search_carrier_accounts(*, current_company_id=None, query=None)[source]

GET /companies/search/carrier-accounts

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/search_carrier_accounts.html Query params: CarrierAccountSearchParams

Parameters:

current_company_id (str | None)
query (str | None)

Return type:

None

suggest_carriers(*, tracking_number)[source]

GET /companies/suggest-carriers

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/suggest_carriers.html Query params: SuggestCarriersParams

Parameters:: tracking_number (str)
Return type:: None

get_carrier_accounts(company_id)[source]

GET /companies/{companyId}/carrierAcounts

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_carrier_accounts.html Response model: List[CarrierAccount]

Parameters:: company_id (str)
Return type:: list[CarrierAccount]

save_carrier_accounts(company_id, *, data)[source]

POST /companies/{companyId}/carrierAcounts.

Parameters:

company_id (str) – Company ID or code.
data (CarrierAccountSaveRequest | dict) – Carrier account payload. Accepts a CarrierAccountSaveRequest instance or a dict.

Return type:

None

Request model: CarrierAccountSaveRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/save_carrier_accounts.html Request model: CarrierAccountSaveRequest

get_packaging_settings(company_id)[source]

GET /companies/{companyId}/packagingsettings

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_packaging_settings.html Response model: PackagingSettings

Parameters:: company_id (str)
Return type:: PackagingSettings

save_packaging_settings(company_id, *, data)[source]

POST /companies/{companyId}/packagingsettings.

Parameters:

company_id (str) – Company ID or code.
data (PackagingSettingsSaveRequest | dict) – Packaging settings payload. Accepts a PackagingSettingsSaveRequest instance or a dict.

Return type:

None

Request model: PackagingSettingsSaveRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/save_packaging_settings.html Request model: PackagingSettingsSaveRequest

get_packaging_labor(company_id)[source]

GET /companies/{companyId}/packaginglabor

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_packaging_labor.html Response model: PackagingLabor

Parameters:: company_id (str)
Return type:: PackagingLabor

save_packaging_labor(company_id, *, data)[source]

POST /companies/{companyId}/packaginglabor.

Parameters:

company_id (str) – Company ID or code.
data (PackagingLaborSaveRequest | dict) – Packaging labor rates payload. Accepts a PackagingLaborSaveRequest instance or a dict.

Return type:

None

Request model: PackagingLaborSaveRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/save_packaging_labor.html Request model: PackagingLaborSaveRequest

get_inherited_packaging_tariffs(company_id)[source]

GET /companies/{companyId}/inheritedPackagingTariffs

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_inherited_packaging_tariffs.html Query params: InheritFromParams Response model: List[PackagingTariff]

Parameters:: company_id (str)
Return type:: list[PackagingTariff]

get_inherited_packaging_labor(company_id)[source]

GET /companies/{companyId}/inheritedpackaginglabor

Docs: https://ab-sdk.readthedocs.io/en/latest/api/companies/get_inherited_packaging_labor.html Query params: InheritFromParams Response model: PackagingLabor

Parameters:: company_id (str)
Return type:: PackagingLabor

get(company_id)[source]

Alias for get_fulldetails().

Parameters:: company_id (str)
Return type:: CompanyDetails

available()[source]

Alias for available_by_current_user().

Return type:: list[CompanySimple]

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.companies.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

get_by_id

GET /companies/{id} — Retrieve a company by UUID or company code.

Returns: CompanySimple

from ab import ABConnectAPI

api = ABConnectAPI(env="staging")
company = api.companies.get_by_id("93179b52-3da9-e311-b6f8-000c298b59ee")
print(company.name)

# Also accepts company codes (resolved via CodeResolver)
company = api.companies.get_by_id("14004OH")

get_details

GET /companies/{companyId}/details — Company detail summary.

Returns: CompanyDetails

details = api.companies.get_details("93179b52-...")
print(details.details)

get_fulldetails

GET /companies/{companyId}/fulldetails — Full editable company details.

Returns: CompanyDetails

full = api.companies.get_fulldetails("93179b52-...")

update_fulldetails

PUT /companies/{companyId}/fulldetails — Update company details.

Returns: CompanyDetails

api.companies.update_fulldetails("93179b52-...", {"name": "Updated Name"})

create

POST /companies/fulldetails — Create a new company.

Returns: New company ID string.

new_id = api.companies.create({"name": "New Co", "code": "NEWCO"})

search

POST /companies/search/v2 — Search companies.

Returns: list[SearchCompanyResponse]`

results = api.companies.search({"searchText": "Navis"})

list

POST /companies/list — Paginated company list.

Returns: list[CompanySimple]`

companies = api.companies.list({"page": 1, "pageSize": 25})

available_by_current_user

GET /companies/availableByCurrentUser — Companies accessible to the current user.

Returns: list[CompanySimple]`

my_companies = api.companies.available_by_current_user()