Download OpenAPI specification:Download
This endpoint return list of all products (Category filters can be included)
| categoryIds | Array of strings <uuid> [ items <uuid > ] |
[- {
- "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
}
]This endpoint return details and price of a specific product
| id required | string <uuid> |
{- "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
}This endpoint create a return request for a specified take request (report issue on a purchase)
{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 |
{- "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
- "returnReasonCode": "string",
- "description": "string",
- "attachmentUrls": [
- "string"
]
}{- "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}This endpoint create a warning return request for a specified take request (like as normal return request endpoint, but fast and without description)
{ReturnReasonCode = "INVALID_CODE","ALREADY_REDEEMED","DIFFERENT_VALUE","DIFFERENT_REGION"}
| inventoryId | string <uuid> |
| returnReasonCode | string or null |
{- "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
- "returnReasonCode": "string"
}{- "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}This endpoint add a reply in a specified return request
| inventoryId | string <uuid> |
| text | string or null |
| attachmentUrls | Array of strings or null |
{- "inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
- "text": "string",
- "attachmentUrls": [
- "string"
]
}{- "replyId": "6d42edee-5271-4595-87fa-97aecee6e8c4"
}This endpoint return detials of a specified return request
| inventoryId required | string <uuid> |
{- "returnReasonCode": "string",
- "ticketNumber": "string",
- "createAt": "2019-08-24T14:15:22Z",
- "underMediation": true,
- "status": 0,
- "replies": [
- {
- "createAt": "2019-08-24T14:15:22Z",
- "text": "string",
- "shopId": "70542939-296f-4335-b0b1-f4e5a2513ef7",
- "isEvent": true,
- "attachmentUrls": [
- "string"
]
}
], - "supportTicketId": "dbad943e-c4f7-4323-af51-e21bc7131a55"
}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:
Status = 400 with a message from the order service.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.This product is not a subscription.eligible seller not found.
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"} |
{- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "referenceId": "string",
- "identities": {
- "property1": "string",
- "property2": "string"
}
}{- "message": "string",
- "status": 0,
- "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
- "orderNumber": "string"
}This endpoint return validation result of a specified user identity.
| productId | string <uuid> |
object or null |
{- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "identities": {
- "property1": "string",
- "property2": "string"
}
}{- "isValid": true,
- "message": "string"
}This endpoint register a new take request (In case of adjustment of stock supply, this is considered as a new purchase)
| productId | string <uuid> |
| deliveryKey | string or null |
{- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "deliveryKey": "string"
}{- "takeoutInventoryId": "897813f5-064f-4b0a-8e57-337e07232386"
}This endpoint return details of a specified take request.
Decryption Details for EncryptedVirtualCollections -> decryption-details.pdf
| deliveryKey required | string |
{- "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
}