Skip to main content
POST
/
v1
/
admin
/
catalog
/
quote
Quote a catalog entity
curl --request POST \
  --url https://{operatorDomain}/v1/admin/catalog/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityModule": "products",
  "entityId": "prod_01h...",
  "sourceKind": "<string>",
  "sourceProvider": "<string>",
  "sourceConnectionId": "<string>",
  "sourceRef": "<string>",
  "scope": {
    "locale": "<string>",
    "market": "<string>",
    "currency": "<string>"
  },
  "parameters": {},
  "draft": {},
  "ttlMs": 123
}
'
{
  "quoteId": "<string>",
  "quotedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "available": true,
  "invalidReason": "<string>",
  "pricing": {
    "currency": "<string>",
    "lines": [
      {}
    ],
    "taxes": [
      {}
    ],
    "subtotal": 123,
    "taxTotal": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Body

application/json
entityModule
string
required
Example:

"products"

entityId
string
required
Example:

"prod_01h..."

sourceKind
string
sourceProvider
string
sourceConnectionId
string
sourceRef
string
scope
object
parameters
object
draft
object
ttlMs
integer

Response

200 - application/json

Quote

quoteId
string
quotedAt
string<date-time>
expiresAt
string<date-time>
available
boolean
invalidReason
string
pricing
object