Declare Stock

Automate your stock with "Declared Stock"

The "Declared Stock" feature allows you to declare the number of keys you have for particular product without placing the keys to Driffle stock.

During the purchase process, Driffle.com will call your system twice. The first call will ask you to reserve the keys for a specific order - a Reservation request. The second one will ask you to provide the purchased keys, called a Provision request.

Example

You create an auction with 10 keys and using the “Declared Stock” feature declare 50 keys. This means that Driffle.com will attempt to sell 60 keys in total. First, the platform will sell 10 existing keys, then will use the "Declared Stock" feature to retrieve 50 keys more. If you create an auction with no keys and with the "Declared Stock" feature declare that you have 50 keys, then Driffle.com will attempt to retrieve those 50 keys and sell them.

Please read the detailed Declare Stock Feature Integration Guide to start using this API.

This API updates the total number of declared stock for an offer.

Example - previous value of declared stock - 10 new value of declared stock sent in payload - 20 updated value of declared stock - 20

POST /offer/declare-stock/{id}

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

declaredStock

number | null

Number of keys to be declared through API keys

Response

{
  "message": "string",
  "statusCode": 200,
  "data": {
    "offerId": 0,
    "declaredStock": 0,
    "totalAvailableStock": 0
  }
}

Last updated