Freight Simulation

post

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

A freight simulation endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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).

Path Params

plataformId

string

required

Defaults to stringPlataformId

Identification of an plataform string

clientId

string

required

Defaults to stringClientId

Retailer identification value

Query Params

ShouldCheckStock

boolean

Defaults to false

Indicates whether the system should check the integrated SKU stock before returning results.

AllowPackageSplit

boolean

Defaults to false

Allows the order to be split among different stores if availability conditions permit.

AllowUnavailableItem

boolean

Defaults to false

Allows quoting items that don’t exist in the catalog (for integrations that use only dimensions).

Persist

boolean

Defaults to false

Defines whether the quote should be saved for later consultation (valid for up to 15 days).

UseCatalogMeasure

boolean

Defaults to false

Forces the use of product catalog dimensions, making it unnecessary to send Dimensions in the request.

MaxResults

int32

Defaults to 1

Limits the maximum number of results returned by the quote.

ShouldPackagedIndividually

boolean

Defaults to false

Forces the quote to be calculated per item, even when multiple items are requested.

IgnoredSellerCodes

array of strings

Defaults to ["19761043000118"]

List of seller CNPJs (codes) that should be ignored, even if they have stock.

IgnoredSellerCodes

SellerCodes

array of strings

Defaults to ["19761043000118"]

List of seller CNPJs allowed for the quote.

SellerCodes

UniqueSlas

boolean

Defaults to false

Returns only a single SLA per item to simplify the response.

Body Params

originIdentifier

string

Defaults to 80730280

Store ZipCode to specify the shipping simulation location

postalCode

string

required

Defaults to 00000000

Buyer zipCode to determinate delivery route

items

array of objects

required

A list of freightItem

items*

Response

Language

URL

Loading…

Response

Choose an example:

application/json

Query Parameters

Request Body Fields

Response Fields

200200