Skip to main content

Product Upsert Many Ep

POST 
/v1/product/upsert_many

Create/Update Product Information

Manages the creation or update of product information, enabling precise control over product data including integration identifiers, names, and specific attributes like specific gravity and enabled status.

Required Scopes (ia.w)

Request​

id: str | None = None
Internal identifier unique to a product. If provided, the request will be treated as an update.

source_id: str | None = None
Identifier from an external system if the data is received through integration.

source_system_id: str | None = None
Identifier for the source system if the data is received through integration.

name: str
Name unique to the product.

enabled: bool | None = None
Indicates whether the product is enabled.

specific_gravity: float | None = None
The specific gravity of the fuel, defaulting to 1 if not specified.

short_name: str | None = None
Abbreviated name for the product, with a maximum length of 10 characters.

icon: str | None = None
Icon code that maps to an icon displayed on the tank lid.

group: str | None = None
The product group of the product.

weight_group: str | None = None
Weight group of the product that maps to a trailer configuration code to determine load strategy.

display_rank: int | None = None
Controls the order products are listed in. Lower ranks sort first.

tank_lid_code_id: str | None = None
Internal identifier of the tank lid code associated with the product, used to mark the tank lid in the in-cab app.

product_color_id: str | None = None
Internal identifier of the product color, configured under Manage Product Colors.

api_number: str | None = None
The product's API number.

un_number: str | None = None
The product's UN number. Printed in the material-safety section of the delivery ticket.

percent_entry: bool = False
When true, drops into a tank configured with this product capture driver-entered percent-full and temperature readings instead of stick inches.

supply_map: list[SourceMap] = None
List of source_system and source_id mappings. Used for eBOL process.

Details

Show SourceMap Attributes source_system: str
System name.

source_id: str
ID in the source system.

extra_data: dict = {}
Any additional data provided or managed by the client through integration endpoints.

Show Deprecated

alias: str | None = None
Deprecated. An alternative name or alias for the product.


Response​

created: int
The number of products created in the system.

updated: int
The number of products updated in the system.

Responses​

Successful Response

Loading...