Integration (v1)

Download OpenAPI specification:Download

OrderCredit

Check Credit Balance

This endpoint return balance of your credit to register new order

Authorizations:
access-keysecret-key

Responses

Response samples

Content type
application/json
{
  • "balance": 0.1
}

Product

Get Products

This endpoint return list of all products (Category filters can be included)

Authorizations:
access-keysecret-key
query Parameters
categoryIds
Array of strings <uuid> [ items <uuid > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Details

This endpoint return details and price of a specific product

Authorizations:
access-keysecret-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "price": 0.1,
  • "realPrice": 0.1,
  • "currency": "string",
  • "isPriceExceeded": true,
  • "status": 0
}

ProductCategory

Get Categories

This endpoint return list of all product categories

Authorizations:
access-keysecret-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ReturnInventory

Return request

This endpoint create a return request for a specified take request (report issue on a purchase)

Authorizations:
access-keysecret-key
Request Body schema:

{ReturnReasonCode = "INVALID_CODE","ALREADY_REDEEMED","DIFFERENT_VALUE","DIFFERENT_REGION"}

inventoryId
string <uuid>
returnReasonCode
string or null
description
string or null
attachmentUrls
Array of strings or null

Responses

Request samples

Content type
{
  • "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
  • "returnReasonCode": "string",
  • "description": "string",
  • "attachmentUrls": [
    ]
}

Response samples

Content type
application/json
{
  • "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}

Return request (Warning)

This endpoint create a warning return request for a specified take request (like as normal return request endpoint, but fast and without description)

Authorizations:
access-keysecret-key
Request Body schema:

{ReturnReasonCode = "INVALID_CODE","ALREADY_REDEEMED","DIFFERENT_VALUE","DIFFERENT_REGION"}

inventoryId
string <uuid>
returnReasonCode
string or null

Responses

Request samples

Content type
{
  • "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
  • "returnReasonCode": "string"
}

Response samples

Content type
application/json
{
  • "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}

Return Request Reply

This endpoint add a reply in a specified return request

Authorizations:
access-keysecret-key
Request Body schema:
inventoryId
string <uuid>
text
string or null
attachmentUrls
Array of strings or null

Responses

Request samples

Content type
{
  • "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
  • "text": "string",
  • "attachmentUrls": [
    ]
}

Response samples

Content type
application/json
{
  • "replyId": "6d42edee-5271-4595-87fa-97aecee6e8c4"
}

Start Mediation

This endpoint start mediation in a specified return request

Authorizations:
access-keysecret-key
path Parameters
inventoryId
required
string <uuid>

Responses

Close Return request

This endpoint close a specified return request

Authorizations:
access-keysecret-key
path Parameters
inventoryId
required
string <uuid>

Responses

Get Details

This endpoint return detials of a specified return request

Authorizations:
access-keysecret-key
path Parameters
inventoryId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "returnReasonCode": "string",
  • "ticketNumber": "string",
  • "createAt": "2019-08-24T14:15:22Z",
  • "underMediation": true,
  • "status": 0,
  • "replies": [
    ],
  • "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}

Subscriptions

Subscription Activation

This endpoint creates an order to activate a subscription product.
It is idempotent based on the tuple (ReferenceId, ProductId, Identities): if an order already exists for the same tuple, the previously created order is returned.

Notes:

  • If there is not enough credit, the response will be Status = 400 with a message from the order service.
  • When a previous order exists for the same tuple, that order’s payload is returned with its original HTTP status.

API Guide - Create Subscription Activation -> API-guide-create-subscription-activation.pdf

Request example { "referenceId": "ACT-2025-000123", "productId": "8f1b7f3e-0e47-4a1f-8e4a-9a7d3f1b2c55", "identities": { "username": "my_username" } } Successful response (200) { "orderId": "3f2d9f0e-1a44-47b5-9d8f-8c7e4b2a1c00", "orderNumber": "24091542", "status": 200, "message": "Subscription activation created successfully" } Validation / business error (400) { "status": 400, "message": "This product is not a subscription." } Existing order returned (idempotent hit) { "orderId": "3f2d9f0e-1a44-47b5-9d8f-8c7e4b2a1c00", "orderNumber": "24091542", "status": 200, "message": "Subscription activation created successfully" } Possible 400 messages:Payload is null.Input validation error returned by rules (e.g., missing identity keys).This product is not a subscription.eligible seller not found.Order service message (e.g., not enough credit).

Authorizations:
access-keysecret-key
Request Body schema:

Request payload containing ReferenceId, ProductId, and Identities (a key/value object that will be serialized as supply identity).

productId
string <uuid>
referenceId
string or null

a unique key for your order (generate by you in any structure)

object or null

You can find the properties associated with each product in the product description in your user panel. example: {"username":"example_username"}

Responses

Request samples

Content type
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "referenceId": "string",
  • "identities": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  • "orderNumber": "string"
}

/v2/Subscriptions

Authorizations:
access-keysecret-key
query Parameters
referenceId
string

Responses

Response samples

Content type
No sample

Check Identifier Validity

This endpoint return validation result of a specified user identity.

Authorizations:
access-keysecret-key
Request Body schema:
productId
string <uuid>
object or null

Responses

Request samples

Content type
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "identities": {
    }
}

Response samples

Content type
application/json
{
  • "isValid": true,
  • "message": "string"
}

TakeoutInventory

Take inventory

This endpoint register a new take request (In case of adjustment of stock supply, this is considered as a new purchase)

Authorizations:
access-keysecret-key
Request Body schema:
productId
string <uuid>
deliveryKey
string or null

Responses

Request samples

Content type
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "deliveryKey": "string"
}

Response samples

Content type
application/json
{
  • "takeoutInventoryId": "897813f5-064f-4b0a-8e57-337e07232386"
}

Get Details

This endpoint return details of a specified take request.

Decryption Details for EncryptedVirtualCollections -> decryption-details.pdf

Authorizations:
access-keysecret-key
query Parameters
deliveryKey
required
string

Responses

Response samples

Content type
application/json
{
  • "takeoutInventoryId": "897813f5-064f-4b0a-8e57-337e07232386",
  • "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
  • "entryPrice": 0.1,
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "encryptedVirtualCollections": "string",
  • "webhookDeliveredError": "string",
  • "isCanceled": true
}

Cancel Take inventory

This endpoint cancel a specified take request (before supply)

Authorizations:
access-keysecret-key
path Parameters
takeoutInventoryId
required
string <uuid>

Responses