Consumer Order Quantity
Manage consumer order quantity tracking for products.
Base URL: /api/v1/partner/store/consumer-order-qty
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /{productId}/ | Get Consumer Order Quantity By Product |
| DELETE | /consumerCart/{consumerCartId} | Delete consumer order quantities |
| DELETE | /{consumerOrderQtyId} | Delete ConsumerOrderQty |
Get Consumer Order Quantity By Product
GET /api/v1/partner/store/consumer-order-qty/{productId}/
Retrieve all consumer order quantity records for a specific product. Returns quantity tracking data including current order counts and limits.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
productId | string | The product i d |
Response
Returns a list of ConsumerOrderQuantity objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
inventoryId | string | No | Inventory identifier |
regionId | string | No | Region identifier |
productId | string | No | Product identifier |
consumerCartId | string | No | Consumer Cart identifier |
quantity | number | No | Quantity |
processedTime | long | No | Processed timestamp (epoch ms) |
active | boolean | No | Whether active |
submitted | boolean | No | Submitted |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"inventoryId": "abc123",
"regionId": "abc123",
"productId": "abc123",
"consumerCartId": "abc123",
"quantity": 0,
"processedTime": 1704067200000,
"active": false,
"submitted": false
}
Delete consumer order quantities
DELETE /api/v1/partner/store/consumer-order-qty/consumerCart/{consumerCartId}
Deactivate all order quantity records associated with a specific consumer cart. This is a bulk operation that soft-deletes all quantity tracking entries for the cart.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
consumerCartId | string | The consumer cart i d |
Delete ConsumerOrderQty
DELETE /api/v1/partner/store/consumer-order-qty/{consumerOrderQtyId}
Delete a single consumer order quantity record by its ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
consumerOrderQtyId | string | The consumer order qty i d |