Skip to Content
Developers
Pro Deals

Get a Pro Deal

GET
/pro-deals/{id}

Authorization

integrationKey
headerAuthorizationBearer <token>

A brand integration key, created by an Owner or Admin in Brand Settings › Integrations and shown once. endvr_ik_test_… keys write test data that is never billed; endvr_ik_live_… keys are live.

Path Parameters

id*string

Pro Deal id.

Example"6730f1c2a9d4e5b6c7d8e9f0"

Response Body

The Pro Deal.

application/json
  1. response
id*string
title*string
status*ProDealStatus
Value in"draft""scheduled""live""paused""finished"
discount*
codesPerAssociate*integer

How many codes each associate can claim, one after the other.

Range1 <= value <= 5
codeSource*string

generated: ENDVR generates the codes for you to create; uploaded: you upload your own.

Value in"generated""uploaded"
codesReady*boolean

True once you confirmed the codes are live in your store.

codes*

How many codes are in each state.

startsAt*|
Formatdate-time
endsAt*|
Formatdate-time
Example Request
curl -X GET 'https://api.endvr.io/v1/pro-deals/6730f1c2a9d4e5b6c7d8e9f0'
Example Response
{  "id": "string",  "title": "string",  "status": "draft",  "discount": {    "type": "percentage",    "value": 0  },  "codesPerAssociate": 1,  "codeSource": "generated",  "codesReady": true,  "codes": {    "total": 0,    "available": 0,    "assigned": 0,    "used": 0,    "deactivated": 0  },  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z"}