Freight Simulation

Shipping Simulation

The shipping simulation simulates and analyzes the available shipping options. The simulation checks the shipping conditions, enabling the retailer to assess item availability across multiple stores/regions, delivery methods, costs, and deadlines.

Item Availability:

Checks if the item is in stock.
Verifies if it's possible to ship the item (e.g., checks for available carriers in that region).
If any of the criteria are not met, the simulation assumes the item is unavailable.

Path Params

PlataformId: is shared by the business team.
ClientId: is generated when set up Retailer account. (first of all)

Body

Only quantity and additionalDeliveryDays need to be passed as integers.
Everything else is forced string

xxxxxxxxxx
curl --request POST \
     --url https://environment.neomode.com.br/oms/stringPlataformId/stringClientId/pvt/orderForms/simulation \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "originIdentifier": "80730280",
  "postalCode": "00000000"
}
'

200200

400400