1. Getting Started – Prerequisites
For reference and additional information on getting started, the Ultra Commerce Private API documentation can be found on Postman.
2. Endpoint
Set the endpoint for the public requests to:
/api/v1/public/search
3. Request Schema
Use the documentation below to build, customize and configure search and data requests against objects in the Ultra Commerce environment.
{
type: "object",
additionalProperties: false,
properties: {
query: {
type: "string"
},
pageFrom: {
anyOf: [
{ "type": "string" },
{ "type": "integer" }
]
},
pageSize: {
anyOf: [
{ "type": "string" },
{ "type": "integer" }
]
},
sort: {
type: "string"
},
route: {
type: "string"
},
facets: {
type: "array",
items: {
type: "object",
required: ["key", "value"],
additionalProperties: false,
properties: {
key: {
type: "string"
},
value: {
type: "string"
}
}
}
},
filters: {
type: "array",
items: {
type: "object",
required: ["key", "value"],
additionalProperties: false,
properties: {
key: {
type: "string"
},
value: {
type: "string"
}
}
}
},
type: {
enum: ['product', 'sku']
}
}
}