product.services.rehive.io
Open in
urlscan Pro
2606:4700:10::ac43:2857
Public Scan
URL:
https://product.services.rehive.io/
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* activate
* postActivate service
* admin
* getList categories
* postCreate category
* getRetrieve category
* putUpdate category
* patchPartially update category
* delDelete category
* getRetrieve company
* putUpdate company
* patchPartially update company
* getList currencies
* getRetrieve currency
* getList integrations
* postCreate integration
* getRetrieve integration
* putUpdate integration
* patchPartially update integration
* delDelete integration
* getList integration webhooks
* postCreate integration webhook
* getRetrieve integration webhook
* putUpdate integration webhook
* patchPartially update integration webhook
* delDelete integration webhook
* getList orders
* postCreate order
* getRetrieve order
* putUpdate order
* patchPartially update order
* delDelete order
* getList order items
* postCreate order item
* getList payments
* postCreate payment
* getList refunds
* postCreate refund
* getRetrieve order item
* putUpdate order item
* patchPartially update order item
* delDelete order item
* getRetrieve payment
* putUpdate payment
* patchPartially update payment
* getRetrieve refund
* putUpdate refund
* patchPartially update refund
* getList products
* postCreate product
* getRetrieve product
* putUpdate product
* patchPartially update product
* delDelete product
* getList product categories
* postCreate product category
* getList product options
* postCreate product option
* getList product prices
* postCreate product price
* getList product variants
* postCreate product variant
* getRetrieve product category
* delDelete product category
* getList product images
* postCreate product image
* getRetrieve product image
* putUpdate product image
* patchPartially update product image
* delDelete product image
* getRetrieve product option
* putUpdate product option
* patchPartially update product option
* delDelete product option
* getRetrieve product price
* putUpdate product price
* patchPartially update product price
* delDelete product price
* getRetrieve product variant
* putUpdate product variant
* patchPartially update product variant
* delDelete product variant
* getList product variant prices
* postCreate product variant price
* getRetrieve product variant price
* putUpdate product variant price
* patchPartially update product variant price
* delDelete product variant price
* getList redemptions
* postCreate redemption
* getRetrieve redemption
* getList sellers
* getRetrieve seller
* putUpdate seller
* patchPartially update seller
* getList voucher imports
* postCreate voucher imports
* getRetrieve voucher import
* getList vouchers
* postCreate voucher
* getRetrieve voucher
* putUpdate voucher
* patchPartially update voucher
* delDelete voucher
* getList voucher actions
* getRetrieve voucher action
* postImport vouchers
* postQuery voucher
* deactivate
* postDeactivate service
* manager
* getList categories
* getRetrieve category
* getRetrieve company
* getList currencies
* getRetrieve currency
* getList sellers
* postCreate seller
* getRetrieve seller
* putUpdate seller
* patchPartially update seller
* getList integrations
* postCreate integration
* getRetrieve integration
* putUpdate integration
* patchPartially update integration
* delDelete integration
* getList integration webhooks
* postCreate integration webhook
* getRetrieve integration webhook
* putUpdate integration webhook
* patchPartially update integration webhook
* delDelete integration webhook
* getList orders
* getRetrieve order
* putUpdate order
* patchPartially update order
* getList order items
* getList payments
* getList refund
* postCreate refund
* getRetrieve order item
* putUpdate order item
* patchPartially update order item
* getRetrieve payment
* putUpdate payment
* patchPartially update payment
* getRetrieve refund
* putUpdate refund
* patchPartially update refund
* getList products
* postCreate product
* getRetrieve product
* putUpdate product
* patchPartially update product
* delDelete product
* getList product categories
* postCreate product category
* getList product option
* postCreate product option
* getList product prices
* postCreate product price
* getList product variants
* postCreate product variant
* getRetrieve product category
* delDelete product category
* getList product image
* postCreate product image
* getRetrieve product image
* putUpdate product image
* patchPartially update product image
* delDelete product image
* getRetrieve product option
* putUpdate product option
* patchPartially update product option
* delDelete product option
* getRetrieve product price
* putUpdate product price
* patchPartially update product price
* delDelete product price
* getRetrieve product variant
* putUpdate product variant
* patchPartially update product variant
* delDelete product variant
* getList product variant prices
* postCreate product variant price
* getRetrieve product variant price
* putUpdate product variant price
* patchPartially update product variant price
* delDelete product variant price
* getList redemptions
* postCreate redemption
* getRetrieve redemption
* getList voucher imports
* postCreate voucher import
* getRetrieve voucher import
* postImport vouchers
* getList vouchers
* postCreate voucher
* getRetrieve voucher
* putUpdate voucher
* patchPartially update voucher
* delDelete voucher
* getList voucher actions
* getRetrieve voucher actions
* postQuery voucher
* user
* getList categories
* getRetrieve category
* getRetrieve company
* getList orders
* postCreate order
* getRetrieve order
* putUpdate order
* patchPartially update order
* delDelete order
* getList order items
* postCreate order item
* getList payments
* postCreate payment
* getList refunds
* getRetrieve order item
* putUpdate order item
* patchPartially update order item
* delDelete order item
* getRetrieve payment
* getRetrieve refund
* getList products
* getRetrieve product
* getList product price
* getList product variants
* getList product images
* getRetrieve product image
* getRetrieve product price
* getRetrieve product variant
* getList redemptions
* postCreate redemption
* getRetrieve redemption
* getList sellers
* getRetrieve seller
* getList vouchers
* getRetrieve voucher
* getList voucher actions
* getRetrieve voucher action
* postQuery voucher
* webhook
* postReceive Platform webhook
API docs by Redocly
PRODUCT SERVICE API (1 (1))
Download OpenAPI specification:Download
Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service
The Product Service API is used for product and order management in Rehive.
Docs portal
ACTIVATE
ACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
RESPONSES
200
post/activate/
https://product.services.rehive.com/api/activate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
ADMIN
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
id
string <uuid>
name
string
name__contains
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
parent
string
parent__isnull
string
RESPONSES
200
get/admin/categories/
https://product.services.rehive.com/api/admin/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE CATEGORY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 30 characters
parent
string <uuid>
image
string <uri>
RESPONSES
201
post/admin/categories/
https://product.services.rehive.com/api/admin/categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
RETRIEVE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/categories/{identifier}/
https://product.services.rehive.com/api/admin/categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
UPDATE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 30 characters
parent
string <uuid>
image
string <uri>
RESPONSES
200
put/admin/categories/{identifier}/
https://product.services.rehive.com/api/admin/categories/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string <= 30 characters
parent
string <uuid>
image
string <uri>
RESPONSES
200
patch/admin/categories/{identifier}/
https://product.services.rehive.com/api/admin/categories/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
DELETE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/categories/{identifier}/
https://product.services.rehive.com/api/admin/categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/admin/company/
https://product.services.rehive.com/api/admin/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "name": "string"
}
}
UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
manager_groups
Array of strings or null <= 10 items
RESPONSES
200
put/admin/company/
https://product.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "manager_groups": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "name": "string"
}
}
PARTIALLY UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
manager_groups
Array of strings or null <= 10 items
RESPONSES
200
patch/admin/company/
https://product.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "manager_groups": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "name": "string"
}
}
LIST CURRENCIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
code
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/currencies/
https://product.services.rehive.com/api/admin/currencies/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
]
}
}
RETRIEVE CURRENCY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
code
required
string^(\w+)$
RESPONSES
200
get/admin/currencies/{code}/
https://product.services.rehive.com/api/admin/currencies/{code}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
}
LIST INTEGRATIONS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/integrations/
https://product.services.rehive.com/api/admin/integrations/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE INTEGRATION
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
slug
required
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
201
post/admin/integrations/
https://product.services.rehive.com/api/admin/integrations/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/integrations/{identifier}/
https://product.services.rehive.com/api/admin/integrations/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
slug
required
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
200
put/admin/integrations/{identifier}/
https://product.services.rehive.com/api/admin/integrations/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
slug
string <= 50 characters
name
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
200
patch/admin/integrations/{identifier}/
https://product.services.rehive.com/api/admin/integrations/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
DELETE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/integrations/{identifier}/
https://product.services.rehive.com/api/admin/integrations/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
LIST INTEGRATION WEBHOOKS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/integrations/{identifier}/webhooks/
https://product.services.rehive.com/api/admin/integrations/{identifier}/webhooks/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
url
required
string <uri>
secret
string <= 250 characters
RESPONSES
201
post/admin/integrations/{identifier}/webhooks/
https://product.services.rehive.com/api/admin/integrations/{identifier}/webhooks/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
url
required
string <uri>
secret
string <= 250 characters
RESPONSES
200
put/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
url
string <uri>
event
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
secret
string <= 250 characters
RESPONSES
200
patch/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
DELETE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
LIST ORDERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
created
string
created__gt
string
created__lt
string
currency
string
id
string <uuid>
items__status
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
placed
string
placed__gt
string
placed__lt
string
seller
string
status
string
statuses
string
total_price
string
updated
string
updated__gt
string
updated__lt
string
user
string
RESPONSES
200
get/admin/orders/
https://product.services.rehive.com/api/admin/orders/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE ORDER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
user
required
string
RESPONSES
201
post/admin/orders/
https://product.services.rehive.com/api/admin/orders/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "user": "string",
* "currency": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/orders/{identifier}/
https://product.services.rehive.com/api/admin/orders/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "reserved" "placed" "complete" "failed"
* pending - pending
* reserved - reserved
* placed - placed
* complete - complete
* failed - failed
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
put/admin/orders/{identifier}/
https://product.services.rehive.com/api/admin/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "pending",
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "reserved" "placed" "complete" "failed"
* pending - pending
* reserved - reserved
* placed - placed
* complete - complete
* failed - failed
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
patch/admin/orders/{identifier}/
https://product.services.rehive.com/api/admin/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "pending",
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
DELETE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/orders/{identifier}/
https://product.services.rehive.com/api/admin/orders/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
LIST ORDER ITEMS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
categories
string
code
string
countries
string
id
string <uuid>
name
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
quantity
integer
supplier
string
RESPONSES
200
get/admin/orders/{identifier}/items/
https://product.services.rehive.com/api/admin/orders/{identifier}/items/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
product
required
string
quantity
required
integer >= 1
variant
string or null
metadata
object or null
custom_amount
integer or null
RESPONSES
201
post/admin/orders/{identifier}/items/
https://product.services.rehive.com/api/admin/orders/{identifier}/items/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "product": "string",
* "quantity": 1,
* "variant": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
LIST PAYMENTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/admin/orders/{identifier}/payments/
https://product.services.rehive.com/api/admin/orders/{identifier}/payments/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
type
string
Value: "rehive"
* rehive - rehive
RESPONSES
201
post/admin/orders/{identifier}/payments/
https://product.services.rehive.com/api/admin/orders/{identifier}/payments/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "type": "rehive"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST REFUNDS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/admin/orders/{identifier}/refunds/
https://product.services.rehive.com/api/admin/orders/{identifier}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
item
required
string
quantity
required
integer >= 1
type
string
Value: "rehive"
* rehive - rehive
reason
string or null <= 100 characters
RESPONSES
201
post/admin/orders/{identifier}/refunds/
https://product.services.rehive.com/api/admin/orders/{identifier}/refunds/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "type": "rehive",
* "item": "string",
* "quantity": 1,
* "reason": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/items/{item_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
quantity
required
integer >= 0
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
tracking_url
string or null <= 150 characters
metadata
object or null
custom_amount
integer or null
RESPONSES
200
put/admin/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "quantity": 0,
* "status": "processing",
* "tracking_url": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
quantity
integer >= 0
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
tracking_url
string or null <= 150 characters
metadata
object or null
custom_amount
integer or null
RESPONSES
200
patch/admin/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "quantity": 0,
* "status": "processing",
* "tracking_url": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
DELETE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/items/{item_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/payments/{payment_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
put/admin/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/payments/{payment_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
patch/admin/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/payments/{payment_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/refunds/{refund_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
put/admin/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/refunds/{refund_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
patch/admin/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/admin/orders/{order_id}/refunds/{refund_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCTS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
code
string
countries
string
currency
string
enabled
boolean
id
string <uuid>
name
string
name__contains
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
quantity
integer
quantity__gt
integer
quantity__lt
integer
seller
string
seller__isnull
string
supplier
string
RESPONSES
200
get/admin/products/
https://product.services.rehive.com/api/admin/products/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string
name
required
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
201
post/admin/products/
https://product.services.rehive.com/api/admin/products/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{identifier}/
https://product.services.rehive.com/api/admin/products/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
UPDATE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string
name
required
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
200
put/admin/products/{identifier}/
https://product.services.rehive.com/api/admin/products/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
account
string
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
200
patch/admin/products/{identifier}/
https://product.services.rehive.com/api/admin/products/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{identifier}/
https://product.services.rehive.com/api/admin/products/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT CATEGORIES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{identifier}/categories/
https://product.services.rehive.com/api/admin/products/{identifier}/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
categories
required
Array of strings <uuid>
RESPONSES
201
post/admin/products/{identifier}/categories/
https://product.services.rehive.com/api/admin/products/{identifier}/categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "categories": [
* "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT OPTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{identifier}/options/
https://product.services.rehive.com/api/admin/products/{identifier}/options/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
]
}
}
CREATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
values
required
Array of strings
name
string or null <= 50 characters
RESPONSES
201
post/admin/products/{identifier}/options/
https://product.services.rehive.com/api/admin/products/{identifier}/options/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
LIST PRODUCT PRICES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
currency
string
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{identifier}/prices/
https://product.services.rehive.com/api/admin/products/{identifier}/prices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
CREATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
201
post/admin/products/{identifier}/prices/
https://product.services.rehive.com/api/admin/products/{identifier}/prices/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "currency": "string",
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
LIST PRODUCT VARIANTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{identifier}/variants/
https://product.services.rehive.com/api/admin/products/{identifier}/variants/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
]
}
}
CREATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
options
required
object
quantity
required
integer or null
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
tracked
boolean
RESPONSES
201
post/admin/products/{identifier}/variants/
https://product.services.rehive.com/api/admin/products/{identifier}/variants/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
RETRIEVE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
category_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/categories/{category_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
category_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/categories/{category_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT IMAGES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{product_id}/images/
https://product.services.rehive.com/api/admin/products/{product_id}/images/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
weight
integer
RESPONSES
201
post/admin/products/{product_id}/images/
https://product.services.rehive.com/api/admin/products/{product_id}/images/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/images/{image_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
string <uri>
weight
integer
RESPONSES
200
put/admin/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/images/{image_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
string <uri>
weight
integer
RESPONSES
200
patch/admin/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/images/{image_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/images/{image_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/options/{option_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
UPDATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 50 characters
values
Array of strings
RESPONSES
200
put/admin/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/options/{option_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
PARTIALLY UPDATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 50 characters
values
Array of strings
RESPONSES
200
patch/admin/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/options/{option_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
DELETE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/options/{option_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
RETRIEVE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
UPDATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
put/admin/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
PARTIALLY UPDATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
patch/admin/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
DELETE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
RETRIEVE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
UPDATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
options
required
object
quantity
required
integer or null
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
tracked
boolean
RESPONSES
200
put/admin/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
PARTIALLY UPDATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
options
object
quantity
integer or null
tracked
boolean
RESPONSES
200
patch/admin/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
DELETE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
LIST PRODUCT VARIANT PRICES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/products/{product_id}/variants/{variant_id}/prices/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
CREATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
201
post/admin/products/{product_id}/variants/{variant_id}/prices/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "currency": "string",
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
RETRIEVE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
UPDATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
put/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
PARTIALLY UPDATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
patch/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
DELETE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/admin/products/{product_id}/variants/{variant_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
LIST REDEMPTIONS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/redemptions/
https://product.services.rehive.com/api/admin/redemptions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REDEMPTION
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
amount
integer or null
RESPONSES
201
post/admin/redemptions/
https://product.services.rehive.com/api/admin/redemptions/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string",
* "amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REDEMPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/redemptions/{action_id}/
https://product.services.rehive.com/api/admin/redemptions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST SELLERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
RESPONSES
200
get/admin/sellers/
https://product.services.rehive.com/api/admin/sellers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/sellers/{identifier}/
https://product.services.rehive.com/api/admin/sellers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
UPDATE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string <= 30 characters
status
required
string
Enum: "declined" "pending" "verified"
* declined - Declined
* pending - Pending
* verified - Verified
name
string or null <= 200 characters
description
string or null <= 255 characters
metadata
object or null
RESPONSES
200
put/admin/sellers/{identifier}/
https://product.services.rehive.com/api/admin/sellers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
account
string <= 30 characters
status
string
Enum: "declined" "pending" "verified"
* declined - Declined
* pending - Pending
* verified - Verified
metadata
object or null
RESPONSES
200
patch/admin/sellers/{identifier}/
https://product.services.rehive.com/api/admin/sellers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
LIST VOUCHER IMPORTS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/voucher-imports/
https://product.services.rehive.com/api/admin/voucher-imports/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "product": "string",
* "variant": "string",
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
]
}
}
CREATE VOUCHER IMPORTS
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
product
string
variant
string
RESPONSES
201
post/admin/voucher-imports/
https://product.services.rehive.com/api/admin/voucher-imports/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "variant": "string",
* "file": "http://example.com"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "product": "string",
* "variant": "string",
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
}
RETRIEVE VOUCHER IMPORT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/voucher-imports/{id}/
https://product.services.rehive.com/api/admin/voucher-imports/{id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
}
LIST VOUCHERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
code
string
id
string <uuid>
item
string <uuid>
item__isnull
string
order
string <uuid>
order__created
string
order__created__gt
string
order__created__lt
string
order__isnull
string
order__placed
string
order__placed__gt
string
order__placed__lt
string
order__updated
string
order__updated__gt
string
order__updated__lt
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
status
string
RESPONSES
200
get/admin/vouchers/
https://product.services.rehive.com/api/admin/vouchers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE VOUCHER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string <= 100 characters
product
string
variant
string
item
string
serial
string <= 64 characters
expires
integer
RESPONSES
201
post/admin/vouchers/
https://product.services.rehive.com/api/admin/vouchers/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "variant": "string",
* "item": "string",
* "code": "string",
* "serial": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/vouchers/{identifier}/
https://product.services.rehive.com/api/admin/vouchers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "available" "reserved" "purchased" "redeemed" "partially_redeemed"
* available - available
* reserved - reserved
* purchased - purchased
* redeemed - redeemed
* partially_redeemed - partially_redeemed
RESPONSES
200
put/admin/vouchers/{identifier}/
https://product.services.rehive.com/api/admin/vouchers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "available"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "available" "reserved" "purchased" "redeemed" "partially_redeemed"
* available - available
* reserved - reserved
* purchased - purchased
* redeemed - redeemed
* partially_redeemed - partially_redeemed
RESPONSES
200
patch/admin/vouchers/{identifier}/
https://product.services.rehive.com/api/admin/vouchers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "available"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
DELETE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/vouchers/{identifier}/
https://product.services.rehive.com/api/admin/vouchers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
LIST VOUCHER ACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/vouchers/{identifier}/actions/
https://product.services.rehive.com/api/admin/vouchers/{identifier}/actions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE VOUCHER ACTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
voucher_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/vouchers/{voucher_id}/actions/{action_id}/
https://product.services.rehive.com/api/admin/vouchers/{voucher_id}/actions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
IMPORT VOUCHERS
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
product
string
variant
string
RESPONSES
201
post/admin/vouchers/import/
https://product.services.rehive.com/api/admin/vouchers/import/
REQUEST SAMPLES
* Payload
Content type
application/jsonmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "variant": "string",
* "file": "http://example.com"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
QUERY VOUCHER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
RESPONSES
200
post/admin/vouchers/query/
https://product.services.rehive.com/api/admin/vouchers/query/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
DEACTIVATE
DEACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
purge
boolean
Default: false
RESPONSES
200
post/deactivate/
https://product.services.rehive.com/api/deactivate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string",
* "purge": false
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
MANAGER
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
id
string <uuid>
name
string
name__contains
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
parent
string
parent__isnull
string
RESPONSES
200
get/manager/categories/
https://product.services.rehive.com/api/manager/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/categories/{identifier}/
https://product.services.rehive.com/api/manager/categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/manager/company/
https://product.services.rehive.com/api/manager/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "name": "string"
}
}
LIST CURRENCIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
code
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/currencies/
https://product.services.rehive.com/api/manager/currencies/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
]
}
}
RETRIEVE CURRENCY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
code
required
string^(\w+)$
RESPONSES
200
get/manager/currencies/{code}/
https://product.services.rehive.com/api/manager/currencies/{code}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
}
LIST SELLERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/
https://product.services.rehive.com/api/manager/sellers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
CREATE SELLER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string
id
required
string
name
string or null <= 200 characters
description
string or null <= 255 characters
metadata
object or null
RESPONSES
201
post/manager/sellers/
https://product.services.rehive.com/api/manager/sellers/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "name": "string",
* "description": "string",
* "account": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
RETRIEVE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
UPDATE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string
name
string or null <= 200 characters
description
string or null <= 255 characters
metadata
object or null
RESPONSES
200
put/manager/sellers/{seller_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "account": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
account
string
metadata
object or null
RESPONSES
200
patch/manager/sellers/{seller_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "account": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "account": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
LIST INTEGRATIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/integrations/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
slug
required
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
201
post/manager/sellers/{seller_id}/integrations/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/integrations/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
slug
required
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
200
put/manager/sellers/{seller_id}/integrations/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
slug
string <= 50 characters
name
string <= 50 characters
description
string or null <= 255 characters
RESPONSES
200
patch/manager/sellers/{seller_id}/integrations/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "slug": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
DELETE INTEGRATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/integrations/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
}
}
LIST INTEGRATION WEBHOOKS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/integrations/{identifier}/webhooks/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/webhooks/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
url
required
string <uri>
secret
string <= 250 characters
RESPONSES
201
post/manager/sellers/{seller_id}/integrations/{identifier}/webhooks/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{identifier}/webhooks/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
url
required
string <uri>
secret
string <= 250 characters
RESPONSES
200
put/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
url
string <uri>
event
string
Value: "order.item.purchase"
* order.item.purchase - order.item.purchase
secret
string <= 250 characters
RESPONSES
200
patch/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
DELETE INTEGRATION WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
integration_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
webhook_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/integrations/{integration_id}/webhooks/{webhook_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "url": "http://example.com",
* "event": "order.item.purchase",
* "secret": "string",
* "created": 0,
* "updated": 0
}
}
LIST ORDERS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
categories
string
created
string
created__gt
string
created__lt
string
currency
string
id
string <uuid>
items__status
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
placed
string
placed__gt
string
placed__lt
string
status
string
statuses
string
total_price
string
updated
string
updated__gt
string
updated__lt
string
user
string
RESPONSES
200
get/manager/sellers/{seller_id}/orders/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "reserved" "placed" "complete" "failed"
* pending - pending
* reserved - reserved
* placed - placed
* complete - complete
* failed - failed
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
put/manager/sellers/{seller_id}/orders/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "pending",
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "reserved" "placed" "complete" "failed"
* pending - pending
* reserved - reserved
* placed - placed
* complete - complete
* failed - failed
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
patch/manager/sellers/{seller_id}/orders/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "pending",
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
LIST ORDER ITEMS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
categories
string
code
string
countries
string
id
string <uuid>
name
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
quantity
integer
supplier
string
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{identifier}/items/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/items/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
LIST PAYMENTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{identifier}/payments/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/payments/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
LIST REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{identifier}/refunds/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
item
required
string
quantity
required
integer >= 1
type
string
Value: "rehive"
* rehive - rehive
reason
string or null <= 100 characters
RESPONSES
201
post/manager/sellers/{seller_id}/orders/{identifier}/refunds/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{identifier}/refunds/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "type": "rehive",
* "item": "string",
* "quantity": 1,
* "reason": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
tracking_url
string or null <= 150 characters
metadata
object or null
RESPONSES
200
put/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "processing",
* "tracking_url": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
tracking_url
string or null <= 150 characters
metadata
object or null
RESPONSES
200
patch/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "processing",
* "tracking_url": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
put/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
patch/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/payments/{payment_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
put/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "pending" "complete" "failed"
* pending - pending
* complete - complete
* failed - failed
RESPONSES
200
patch/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/orders/{order_id}/refunds/{refund_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "pending"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
categories
string
code
string
countries
string
currency
string
enabled
boolean
id
string <uuid>
name
string
name__contains
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
quantity
integer
quantity__gt
integer
quantity__lt
integer
seller
string
seller__isnull
string
supplier
string
RESPONSES
200
get/manager/sellers/{seller_id}/products/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
201
post/manager/sellers/{seller_id}/products/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
UPDATE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
200
put/manager/sellers/{seller_id}/products/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string <= 50 characters
description
string or null
short_description
string or null
quantity
integer or null
tracked
boolean
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null
instant_buy
boolean
supplier
string or null
countries
Array of strings <= 249 items
Items Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW"
"AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL"
"CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK"
"DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR"
"GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG"
"GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM"
"IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR"
"LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT"
"MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ"
"NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY"
"PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF"
"PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO"
"ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH"
"TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US"
"UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
metadata
object
integration
string or null
requires_shipping_address
boolean
requires_billing_address
boolean
requires_contact_mobile
boolean
requires_contact_email
boolean
enabled
boolean
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "short_description": "string",
* "quantity": 0,
* "tracked": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": "string",
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "integration": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "enabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "quantity": 0,
* "tracked": true,
* "code": "string",
* "instant_buy": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "supplier": "string",
* "countries": [
* "AF"
],
* "enabled": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "integration": {
* "id": "string",
* "slug": "string",
* "name": "string",
* "description": "string",
* "created": 0,
* "updated": 0
},
* "account": "string",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT CATEGORIES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{identifier}/categories/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
categories
required
Array of strings <uuid>
RESPONSES
201
post/manager/sellers/{seller_id}/products/{identifier}/categories/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "categories": [
* "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{identifier}/options/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/options/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
]
}
}
CREATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
values
required
Array of strings
name
string or null <= 50 characters
RESPONSES
201
post/manager/sellers/{seller_id}/products/{identifier}/options/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/options/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
LIST PRODUCT PRICES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
currency
string
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{identifier}/prices/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/prices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
CREATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
201
post/manager/sellers/{seller_id}/products/{identifier}/prices/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/prices/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "currency": "string",
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
LIST PRODUCT VARIANTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{identifier}/variants/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/variants/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
]
}
}
CREATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
options
required
object
quantity
required
integer or null
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
tracked
boolean
RESPONSES
201
post/manager/sellers/{seller_id}/products/{identifier}/variants/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{identifier}/variants/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
RETRIEVE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
category_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/categories/{category_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
category_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/categories/{category_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/images/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
weight
integer
RESPONSES
201
post/manager/sellers/{seller_id}/products/{product_id}/images/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
string <uri>
weight
integer
RESPONSES
200
put/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
string <uri>
weight
integer
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "file": "http://example.com",
* "weight": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
DELETE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/images/{image_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
UPDATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 50 characters
values
Array of strings
RESPONSES
200
put/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
PARTIALLY UPDATE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 50 characters
values
Array of strings
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "values": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
DELETE PRODUCT OPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
option_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/options/{option_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
}
RETRIEVE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
UPDATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
put/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
PARTIALLY UPDATE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
DELETE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
RETRIEVE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
UPDATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
options
required
object
quantity
required
integer or null
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
tracked
boolean
RESPONSES
200
put/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
PARTIALLY UPDATE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
voucher_schema
object or null
A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations
code
string or null <= 100 characters
label
string or null <= 50 characters
options
object
quantity
integer or null
tracked
boolean
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "voucher_schema": {
* "amount": 0,
* "currency": "string"
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
DELETE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
LIST PRODUCT VARIANT PRICES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
CREATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
201
post/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "currency": "string",
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
RETRIEVE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
UPDATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
put/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
PARTIALLY UPDATE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
integer or null
allow_custom_amount
boolean
min_custom_amount
integer or null
max_custom_amount
integer or null
RESPONSES
200
patch/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
DELETE PRODUCT VARIANT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/products/{product_id}/variants/{variant_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
LIST REDEMPTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/redemptions/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/redemptions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REDEMPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
amount
integer or null
RESPONSES
201
post/manager/sellers/{seller_id}/redemptions/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/redemptions/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string",
* "amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REDEMPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/redemptions/{action_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/redemptions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST VOUCHER IMPORTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/voucher-imports/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/voucher-imports/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "product": "string",
* "variant": "string",
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
]
}
}
CREATE VOUCHER IMPORT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
product
string
variant
string
RESPONSES
201
post/manager/sellers/{seller_id}/voucher-imports/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/voucher-imports/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "variant": "string",
* "file": "http://example.com"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "product": "string",
* "variant": "string",
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
}
RETRIEVE VOUCHER IMPORT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/voucher-imports/{id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/voucher-imports/{id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "file": "http://example.com",
* "status": "queued",
* "errors": [
* "string"
]
}
}
IMPORT VOUCHERS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
product
string
variant
string
RESPONSES
201
post/manager/sellers/{seller_id}/voucher/import/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/voucher/import/
REQUEST SAMPLES
* Payload
Content type
application/jsonmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "variant": "string",
* "file": "http://example.com"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
LIST VOUCHERS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
QUERY PARAMETERS
code
string
id
string <uuid>
item
string <uuid>
item__isnull
string
order
string <uuid>
order__created
string
order__created__gt
string
order__created__lt
string
order__isnull
string
order__placed
string
order__placed__gt
string
order__placed__lt
string
order__updated
string
order__updated__gt
string
order__updated__lt
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
status
string
RESPONSES
200
get/manager/sellers/{seller_id}/vouchers/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string <= 100 characters
product
string
item
string
serial
string <= 64 characters
expires
integer
RESPONSES
201
post/manager/sellers/{seller_id}/vouchers/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "product": "string",
* "item": "string",
* "code": "string",
* "serial": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
get/manager/sellers/{seller_id}/vouchers/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "available" "reserved" "purchased" "redeemed" "partially_redeemed"
* available - available
* reserved - reserved
* purchased - purchased
* redeemed - redeemed
* partially_redeemed - partially_redeemed
RESPONSES
200
put/manager/sellers/{seller_id}/vouchers/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "available"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "available" "reserved" "purchased" "redeemed" "partially_redeemed"
* available - available
* reserved - reserved
* purchased - purchased
* redeemed - redeemed
* partially_redeemed - partially_redeemed
RESPONSES
200
patch/manager/sellers/{seller_id}/vouchers/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "status": "available"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
DELETE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
RESPONSES
200
delete/manager/sellers/{seller_id}/vouchers/{identifier}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
LIST VOUCHER ACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
voucher_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/sellers/{seller_id}/vouchers/{voucher_id}/actions/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{voucher_id}/actions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE VOUCHER ACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
seller_id
required
string^\w+$
voucher_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/sellers/{seller_id}/vouchers/{voucher_id}/actions/{action_id}/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/{voucher_id}/actions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
QUERY VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
seller_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
RESPONSES
200
post/manager/sellers/{seller_id}/vouchers/query/
https://product.services.rehive.com/api/manager/sellers/{seller_id}/vouchers/query/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
USER
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
id
string <uuid>
name
string
name__contains
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
parent
string
parent__isnull
string
RESPONSES
200
get/user/categories/
https://product.services.rehive.com/api/user/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/categories/{identifier}/
https://product.services.rehive.com/api/user/categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/user/company/
https://product.services.rehive.com/api/user/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "name": "string"
}
}
LIST ORDERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
created
string
created__gt
string
created__lt
string
currency
string
id
string <uuid>
items__status
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
placed
string
placed__gt
string
placed__lt
string
status
string
statuses
string
total_price
string
updated
string
updated__gt
string
updated__lt
string
RESPONSES
200
get/user/orders/
https://product.services.rehive.com/api/user/orders/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE ORDER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
RESPONSES
201
post/user/orders/
https://product.services.rehive.com/api/user/orders/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "currency": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/orders/{identifier}/
https://product.services.rehive.com/api/user/orders/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
put/user/orders/{identifier}/
https://product.services.rehive.com/api/user/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
shipping_address
object or null
billing_address
object or null
contact_mobile
string or null <= 24 characters
contact_email
string or null <email> <= 254 characters
RESPONSES
200
patch/user/orders/{identifier}/
https://product.services.rehive.com/api/user/orders/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
DELETE ORDER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/user/orders/{identifier}/
https://product.services.rehive.com/api/user/orders/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "items": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
],
* "payments": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
],
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
}
}
LIST ORDER ITEMS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
categories
string
code
string
countries
string
id
string <uuid>
name
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
quantity
integer
supplier
string
RESPONSES
200
get/user/orders/{identifier}/items/
https://product.services.rehive.com/api/user/orders/{identifier}/items/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
product
required
string
quantity
required
integer >= 1
variant
string or null
metadata
object or null
custom_amount
integer or null
RESPONSES
201
post/user/orders/{identifier}/items/
https://product.services.rehive.com/api/user/orders/{identifier}/items/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "product": "string",
* "quantity": 1,
* "variant": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "custom_amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
LIST PAYMENTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/user/orders/{identifier}/payments/
https://product.services.rehive.com/api/user/orders/{identifier}/payments/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
type
string
Value: "rehive"
* rehive - rehive
RESPONSES
201
post/user/orders/{identifier}/payments/
https://product.services.rehive.com/api/user/orders/{identifier}/payments/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "type": "rehive"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST REFUNDS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
type
string
RESPONSES
200
get/user/orders/{identifier}/refunds/
https://product.services.rehive.com/api/user/orders/{identifier}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/items/{item_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
quantity
required
integer >= 0
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
custom_amount
integer or null
RESPONSES
200
put/user/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "quantity": 0,
* "status": "processing",
* "custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
quantity
integer >= 0
status
string or null
Enum: "processing" "shipped" "fulfilled" "complete" "failed" "" null
* processing - processing
* shipped - shipped
* fulfilled - fulfilled
* complete - complete
* failed - failed
custom_amount
integer or null
RESPONSES
200
patch/user/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/items/{item_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "quantity": 0,
* "status": "processing",
* "custom_amount": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
DELETE ORDER ITEM
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
item_id
required
string^([a-zA-Z0-9\_\-]+)$
order_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/user/orders/{order_id}/items/{item_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/items/{item_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": "string",
* "variant": {
* "property1": null,
* "property2": null
},
* "code": "string",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "categories": [
* "string"
],
* "vouchers": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
}
],
* "account": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE PAYMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
payment_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/orders/{order_id}/payments/{payment_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/payments/{payment_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
order_id
required
string^([a-zA-Z0-9\_\-]+)$
refund_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/orders/{order_id}/refunds/{refund_id}/
https://product.services.rehive.com/api/user/orders/{order_id}/refunds/{refund_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "rehive",
* "amount": 0,
* "status": "pending",
* "item": "string",
* "quantity": 0,
* "reason": "string",
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST PRODUCTS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
code
string
countries
string
currency
string
enabled
boolean
id
string <uuid>
name
string
name__contains
string
orderby
Array of strings
Items Enum: "-created" "-updated" "created" "updated"
Sortierung
* created - Erzeugt
* -created - Created (descending)
* updated - Updated
* -updated - Updated (descending)
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
quantity
integer
quantity__gt
integer
quantity__lt
integer
seller
string
seller__isnull
string
supplier
string
RESPONSES
200
get/user/products/
https://product.services.rehive.com/api/user/products/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "quantity": 0,
* "tracked": true,
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE PRODUCT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/products/{identifier}/
https://product.services.rehive.com/api/user/products/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "description": "string",
* "short_description": "string",
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
],
* "quantity": 0,
* "tracked": true,
* "options": [
* {
* "id": "string",
* "name": "string",
* "values": [
* null
]
}
],
* "variants": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
],
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "instant_buy": true,
* "supplier": "string",
* "countries": [
* "AF"
],
* "metadata": {
* "property1": null,
* "property2": null
},
* "images": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
],
* "categories": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0
}
],
* "created": 0,
* "updated": 0
}
}
LIST PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
currency
string
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/products/{identifier}/prices/
https://product.services.rehive.com/api/user/products/{identifier}/prices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
LIST PRODUCT VARIANTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
id
string <uuid>
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/products/{identifier}/variants/
https://product.services.rehive.com/api/user/products/{identifier}/variants/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
]
}
}
LIST PRODUCT IMAGES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/products/{product_id}/images/
https://product.services.rehive.com/api/user/products/{product_id}/images/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE PRODUCT IMAGE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
image_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/products/{product_id}/images/{image_id}/
https://product.services.rehive.com/api/user/products/{product_id}/images/{image_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "weight": 2147483647,
* "created": 0,
* "updated": 0
}
}
RETRIEVE PRODUCT PRICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
price_id
required
string^([a-zA-Z0-9\_\-]+)$
product_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/products/{product_id}/prices/{price_id}/
https://product.services.rehive.com/api/user/products/{product_id}/prices/{price_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
}
RETRIEVE PRODUCT VARIANT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
product_id
required
string^([a-zA-Z0-9\_\-]+)$
variant_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/products/{product_id}/variants/{variant_id}/
https://product.services.rehive.com/api/user/products/{product_id}/variants/{variant_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
}
}
LIST REDEMPTIONS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/redemptions/
https://product.services.rehive.com/api/user/redemptions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REDEMPTION
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
amount
integer or null
RESPONSES
201
post/user/redemptions/
https://product.services.rehive.com/api/user/redemptions/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string",
* "amount": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE REDEMPTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/redemptions/{action_id}/
https://product.services.rehive.com/api/user/redemptions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "type": "claim",
* "status": "pending",
* "voucher": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "code": "string",
* "status": "available",
* "created": 0,
* "updated": 0
},
* "user": "string",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
LIST SELLERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/sellers/
https://product.services.rehive.com/api/user/sellers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE SELLER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/sellers/{identifier}/
https://product.services.rehive.com/api/user/sellers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
LIST VOUCHERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
code
string
id
string <uuid>
item
string <uuid>
item__isnull
string
order
string <uuid>
order__created
string
order__created__gt
string
order__created__lt
string
order__isnull
string
order__placed
string
order__placed__gt
string
order__placed__lt
string
order__updated
string
order__updated__gt
string
order__updated__lt
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
product
string <uuid>
status
string
RESPONSES
200
get/user/vouchers/
https://product.services.rehive.com/api/user/vouchers/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE VOUCHER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/vouchers/{identifier}/
https://product.services.rehive.com/api/user/vouchers/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
LIST VOUCHER ACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/vouchers/{identifier}/actions/
https://product.services.rehive.com/api/user/vouchers/{identifier}/actions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE VOUCHER ACTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
action_id
required
string^([a-zA-Z0-9\_\-]+)$
voucher_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/vouchers/{voucher_id}/actions/{action_id}/
https://product.services.rehive.com/api/user/vouchers/{voucher_id}/actions/{action_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "type": "claim",
* "status": "pending",
* "code": "string",
* "amount": 0,
* "collection": "string",
* "created": 0,
* "updated": 0
}
}
QUERY VOUCHER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
code
required
string
RESPONSES
200
post/user/vouchers/query/
https://product.services.rehive.com/api/user/vouchers/query/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "code": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "product": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "created": 0,
* "updated": 0
},
* "variant": {
* "id": "string",
* "voucher_schema": {
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
}
},
* "code": "string",
* "label": "string",
* "options": {
* "property1": null,
* "property2": null
},
* "quantity": 0,
* "tracked": true,
* "prices": [
* {
* "id": "string",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "allow_custom_amount": true,
* "min_custom_amount": 0,
* "max_custom_amount": 0
}
]
},
* "item": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "price": 0,
* "total_price": 0,
* "has_custom_amount": true,
* "voucher_schema": {
* "type": "static",
* "creation_type": "manual",
* "redeemer_users": [
* "string"
],
* "redeemer_groups": [
* "string"
],
* "display_format": "raw",
* "amount": 0,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "source_account": "string",
* "lifespan": 0,
* "lifespan_unit": "seconds"
},
* "code": "string",
* "status": "processing",
* "tracking_url": "string",
* "image": "http://example.com",
* "created": 0,
* "updated": 0
},
* "order": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "user": "string",
* "status": "pending",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648,
* "enabled": true
},
* "total_price": 0,
* "shipping_address": {
* "property1": null,
* "property2": null
},
* "billing_address": {
* "property1": null,
* "property2": null
},
* "contact_mobile": "string",
* "contact_email": "user@example.com",
* "requires_shipping_address": true,
* "requires_billing_address": true,
* "requires_contact_mobile": true,
* "requires_contact_email": true,
* "seller": {
* "id": "string",
* "name": "string",
* "description": "string"
},
* "placed": 0,
* "created": 0,
* "updated": 0
},
* "status": "available",
* "code": "string",
* "account": "string",
* "serial": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
WEBHOOK
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.execute"
* currency.create - currency.create
* currency.update - currency.update
* transaction.execute - transaction.execute
id
required
string
RESPONSES
200
post/webhook/
https://product.services.rehive.com/api/webhook/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}