Form Models

Form models for ACPortal API.

class ab.api.models.forms.BillOfLadingParams(*, shipmentPlanId=None, providerOptionIndex=None)[source]

Bases: RequestModel

Query parameters for GET /job/{jobDisplayId}/form/bill-of-lading.

Parameters:

shipmentPlanId (str | None)
providerOptionIndex (int | None)

shipment_plan_id: str | None

provider_option_index: int | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.forms.OperationsFormParams(*, type=None)[source]

Bases: RequestModel

Query parameters for GET /job/{jobDisplayId}/form/operations.

Parameters:: type (str | None)

ops_type: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.forms.FormTypeParams(*, type=None)[source]

Bases: RequestModel

Query parameters for form generation with type selection.

Parameters:: type (str | None)

type: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.forms.PackagingLabelsParams(*, shipmentPlanId=None)[source]

Bases: RequestModel

Query parameters for GET packaging labels.

Parameters:: shipmentPlanId (str | None)

shipment_plan_id: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.forms.FormsShipmentPlan(*, shipmentPlanId=None, providerOptionIndex=None, carrierName=None, serviceType=None, jobShipmentID=None, jobID=None, fromAddressId=None, toAddressId=None, providerID=None, sequenceNo=None, fromLocationCompanyName=None, toLocationCompanyName=None, transportType=None, providerCompanyName=None, optionIndex=None, **extra_data)[source]

Bases: ResponseModel

Shipment plan for BOL selection — GET /job/{jobDisplayId}/form/shipments.

This is the only JSON-returning form endpoint. All other form endpoints return raw PDF bytes.

Parameters:

shipmentPlanId (str | None)
providerOptionIndex (int | None)
carrierName (str | None)
serviceType (str | None)
jobShipmentID (str | None)
jobID (str | None)
fromAddressId (int | None)
toAddressId (int | None)
providerID (str | None)
sequenceNo (int | None)
fromLocationCompanyName (str | None)
toLocationCompanyName (str | None)
transportType (str | None)
providerCompanyName (str | None)
optionIndex (int | None)
extra_data (Any)

shipment_plan_id: str | None

provider_option_index: int | None

carrier_name: str | None

service_type: str | None

job_shipment_id: str | None

job_id: str | None

from_address_id: int | None

to_address_id: int | None

provider_id: str | None

sequence_no: int | None

from_location_company_name: str | None

to_location_company_name: str | None

transport_type: str | None

provider_company_name: str | None

option_index: int | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].