Skip to content
Commerce
/
/
Preview an order

Preview an order

Request

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Path
tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The products you want to describe

business_unit_idstring(Business Unit)required
currency_codestring(Currency Code)
customer_idstring(Customer)
customer_typestring(Customer Type)
Enum:"contact""organization"
productsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}/public/describeProducts' \
  -H 'Content-Type: application/json' \
  -d '{
    "business_unit_id": "string",
    "currency_code": "string",
    "customer_id": "string",
    "customer_type": "contact",
    "products": [
      {
        "id": "string",
        "modifier_options": [
          {
            "option_id": "string",
            "value": "string"
          }
        ],
        "type": "string",
        "variant_options": [
          {
            "option_id": "string",
            "value": "string"
          }
        ]
      }
    ]
  }'

Responses

The order preview was successful

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
currency_codestring(Currency Code)

The currency code used

productsArray of objects
Response
{
  "currency_code": "string",
  "products": [
    { … }
  ]
}