Run Custom Export

POST

/Export/{id}

Exports

Get results from executing a custom export by providing the id of the export in the endpoint path. All associated parameters should be provided in object format in the body. Use the Get available exports endpoint to determine the id and which parameters are expected.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/Export/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Page Index": 1,
    "Results Per Page": 10,
    "Product ID": "PROD234",
    "Vendor ID": "VEND949"
}'

Response Example

200 - Sample Export

[
    {
        "Vendor Name": "A la carte",
        "Product Name": "Apple",
        "Quantity Purchased": 10
    },
    {
        "Vendor Name": "A la carte",
        "Product Name": "Orange",
        "Quantity Purchased": 45
    }
]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Unique ID specific to the API

Body Params application/json

object {0}

Examples

Responses

🟢200OK

application/json

Body

array of:

Additional properties

integer | number | string | boolean

optional

🟠400Bad Request

Modified at 2025-05-16 12:53:06

Get parameter options