Freight Simulation

POST https://{environment}.neomode.com.br/oms/neomode/{clientId}/pvt/orderForms/simulation

A freight simulation endpoint.

Query Parameters

Name	Type	Short Description
ShouldCheckStock	bool	Checks SKU stock availability.
AllowPackageSplit	bool	Allows split delivery between stores.
AllowUnavailableItem	bool	Allows quoting non-existent SKUs.
Persist	bool	Saves quote for up to 15 days.
UseCatalogMeasure	bool	Uses product catalog dimensions.
MaxResults	int	Limits number of results.
ShouldPackagedIndividually	bool	Quotes items separately.
IgnoredSellerCodes	string[]	Blocked seller codes (CNPJs).
SellerCodes	string[]	Allowed seller codes (CNPJs).
UniqueSlas	bool	Returns only one SLA per item.

Request Body Fields

Field	Type	Description
originIdentifier	string	CNPJ (seller code) used as the shipping origin.
postalCode	string	Destination postal code for the quote.
items	array	List of SKUs to simulate.
items[].sku	string	SKU code.
items[].quantity	int	Quantity requested for the SKU.
items[].price	decimal	Unit price of the SKU.
items[].dimensions	object	Object with physical measures of the SKU (required if UseCatalogMeasure=false).
items[].dimensions.width	decimal	Width in centimeters.
items[].dimensions.depth	decimal	Depth in centimeters.
items[].dimensions.weight	decimal	Weight in kilograms.
items[].dimensions.height	decimal	Height in centimeters.

Response Fields

Field	Type	Description
id	string	Simulation identifier.
packages	array	List of generated delivery packages.
packages[].items	array	SKUs included in that package.
packages[].items[].sellers	array	Sellers with available stock for the SKU.
packages[].freights	array	Shipping options available for that package.
unavailables	array	SKUs that were not available for any seller.
combinations	array	Possible combinations of packages or sellers (if applicable).