Partner API reference
Read this alongside getting started and generated examples. The reference describes prepared implementation; deployment and access are checked separately.
Check your key and usage
GET /api/partner/v1/whoami
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
Check your workspace capabilities
GET /api/partner/v1/capabilities
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
Read a fragrance card in a saved look or export a PNG
GET /api/partner/v1/fragrances/{id}/card
| Parameter | Where | Required | Accepted values |
|---|---|---|---|
id | path | Yes | string |
look | query | No | Saved look id, current name or earlier name. string |
format | query | No | json, png, html |
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 304 | Unchanged card; no body and no call charged. |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
Read a card using your approved product reference
GET /api/partner/v1/products/{ref}/card
| Parameter | Where | Required | Accepted values |
|---|---|---|---|
ref | path | Yes | Your approved product reference, URL encoded. string Up to 200 characters. |
look | query | No | Saved look id, current name or earlier name. string |
format | query | No | json, png, html |
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 304 | Unchanged card; no body and no call charged. |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
Find public perfumes by brand and name
GET /api/partner/v1/search
| Parameter | Where | Required | Accepted values |
|---|---|---|---|
q | query | Yes | string Up to 200 characters. |
limit | query | No | integer |
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
Suggest product links for review
POST /api/partner/v1/match
Send the request object described in the downloadable contract.
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.
List your own saved looks
GET /api/partner/v1/looks
| Status | Answer |
|---|---|
| 200 | Successful answer |
| 400 | The shared refusal shape; inspect error.code. |
| 401 | The shared refusal shape; inspect error.code. |
| 403 | The shared refusal shape; inspect error.code. |
| 404 | The shared refusal shape; inspect error.code. |
| 409 | The shared refusal shape; inspect error.code. |
| 410 | The shared refusal shape; inspect error.code. |
| 413 | The shared refusal shape; inspect error.code. |
| 422 | The shared refusal shape; inspect error.code. |
| 429 | The shared refusal shape; inspect error.code. |
| 500 | The shared refusal shape; inspect error.code. |
| 503 | The shared refusal shape; inspect error.code. |
Refusals use error.code; see Errors and refusals. Deployment and business access are checked separately.