/products/calculate

post

https://api.dev.orbit.do/v5/products/calculate

Calculate product offers for a given transport against a transport shape. Returns the offers list (one entry per matched product) along with the transportShapeId echoed back and the epoch-second calculatedAt timestamp the calculation ran at.

When productIds is omitted or empty, the shape's configured sales product set is used. When the resolved set is empty, the response is { transportShapeId, offers: [], calculatedAt } with HTTP 200 (no error).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to calculate product offers for a transport

transport

object

required

transportShapeId

string

required

Internal TransportShape id whose configured products are priced. As returned by GET /transportshapes. Determines which product ids are evaluated when productIds is omitted.

productIds

array of strings

Optional subset of Product ids (UUIDs) to price. When omitted or empty, the shape's configured sales products are priced instead. An empty result set returns zero offers.

productIds

voucherCode

string

Optional voucher code applied to the computed offers. Matched case-insensitively (lower-cased before lookup); an unknown code yields no discount rather than an error.

allowUnavailable

boolean

Whether to still return offers for products made unavailable by shipper/carrier eligibility filters. Defaults to true; set false when the offers are shown to a shipper so restricted products are hidden.

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Calculated product offers