Skip to main content

Consumer Order Quantity

Manage consumer order quantity tracking for products.

Base URL: /api/v1/partner/store/consumer-order-qty

Endpoints Overview

MethodEndpointDescription
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

ParameterTypeDescription
productIdstringThe product i d

Response

Returns a list of ConsumerOrderQuantity objects.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
shopIdstringNoShop identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
inventoryIdstringNoInventory identifier
regionIdstringNoRegion identifier
productIdstringNoProduct identifier
consumerCartIdstringNoConsumer Cart identifier
quantitynumberNoQuantity
processedTimelongNoProcessed timestamp (epoch ms)
activebooleanNoWhether active
submittedbooleanNoSubmitted

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

ParameterTypeDescription
consumerCartIdstringThe 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

ParameterTypeDescription
consumerOrderQtyIdstringThe consumer order qty i d