Skip to main content

Trailer Upsert Many Ep

POST 
/v1/trailer/upsert_many

Bulk Create/Update Trailers

Allows creating new trailers in bulk or updating existing trailers if an identifier is passed. All fields not specified below are considered metadata and currently have no implementation.

Required Scopes (ia.w)

Request​

id: str | None = None
Internal trailer identifier. If the id is provided, the request will be considered an update instead of a create.

trailer_number: str | None = None
The unique number of the trailer.

configuration: str | None = None
Trailer configuration for trailer.

depot: str | None = None
Depot name for trailer.

make: str | None = None
Make of the trailer.

model: str | None = None
Model of the trailer.

weight: int | None = None
Weight of the trailer.

source_id: str | None = None
If received from integration, the identifier used for this trailer within the source system.

source_system_id: str | None = None
If received from integration, the system id within the source system.

attributes: dict[str, bool | float | str] = {}
Custom attributes applied to the trailer, keyed by attribute definition id. Attribute definitions are managed in the application; each definition fixes the value type of its entry (boolean, number, string, or presence-only exists).


Response​

created: int
The number of new trailers created.

updated: int
The number of trailers updated.

errors: list
An array of the requests sent that failed, detailing the cause of the error.

Responses​

Successful Response

{
  "created": 0,
  "updated": 0,
  "errors": [
    "string"
  ]
}
Loading...