Retrieves a document availability result

GET

/api/v1/product/availability/{sku}/{subjectId}

v1-product

Check availability and valid options for a particular product for a particular company identfied by its id

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.kompany.com//api/v1/product/availability//'

Response Example

200 - Example 1

{
    "availability": "string",
    "category": "string",
    "countryCode": "string",
    "description": "string",
    "hasOptions": true,
    "options": [
        "string"
    ],
    "price": 0,
    "provider": "string",
    "sku": "string",
    "type": "string"
}

Request

Path Params

sku

string

required

SKU - 9 character value from a Product object

subjectId

string

required

Subject (e.g. Company) ID - 32 character hex value

Responses

🟢200Product details

application/json

Body

availability

string

required