/products

post

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

Create a new product. The created product is stamped with source: { type: "api-key", apiKeyName } to record which API key authored it.

Required fields. name, description, type, status, productBricks, bulletPoints, and isRequestable are all required — see the schema required array. bulletPoints accepts an empty array ([]) but the key itself must be present, and isRequestable must be a literal true/false (no default).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a product

name

object

Multi-language product name shown to operators and customers. Object keyed by IETF language tag (e.g. en, de).

description

object

Optional localized (en/de) description of the product.

type

string

enum

required

Transaction direction this product is exposed for: 'purchasing' (sourcing only), 'sales' (selling only), or 'salesAndPurchasing' (both).

Allowed:

status

string

enum

required

Initial availability of the product. Inactive products remain in the catalog but are excluded from offers and matching.

Allowed:

productBricks

array of strings

required

Ordered list of ProductBrick IDs that compose this product's pricing, scheduling, feasibility, and context logic.

productBricks*

shipperFilter

string

Optional shipper-side eligibility rule (React Query Builder AST). Restricts which shipper accounts/locations may use this product.

carrierFilter

string

Optional carrier-side eligibility rule (React Query Builder AST). Restricts which carriers may offer this product.

tooltipInfo

array of objects

Optional list of localized tooltip strings shown as contextual hints in the operator UI.

tooltipInfo

bulletPoints

array of objects

required

Marketing highlights displayed on the product page; each entry pairs an icon name with localized text. (required)

bulletPoints*

isRequestable

boolean

required

Whether shippers can explicitly request this product via a CTA, in addition to it being matched automatically by filters. (required)

operatingHours

object

Optional daily availability window for the product, expressed as from/to time-of-day objects (hour/minute/second/millisecond).

disabledWeekdays

array of numbers

Optional weekdays on which the product is unavailable. ISO-style 0=Sunday … 6=Saturday.

disabledWeekdays

requestCTAConfig

object

Optional localized labels overriding the default 'request product' CTA copy in the customer UI.

otherOfferSelectedText

object

Optional localized message shown when a customer selects an alternative offer instead of this one.

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

200created product