Create a new offer

The following API allow you to create a new offer/auction on Driffle.

POST /offer

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

Required arguments

Param	Param Type	Type	Required	Description
product	body	{ productId: number }	Yes	ProductId for which offer needs to be created
yourPrice	body	Number	No (Either yourPrice or retailPrice is required)	Selling price. Commission will be applied to this price.
retailPrice	body	Number	No (Either yourPrice or retailPrice is required)	Retail Price or Buy Box Price. Commission is subtracted from this price.

Optional arguments

Case - Declared Stock

1. Either keys or declaredStock number should be provided in the request.

2. Either yourPrice or retailPrice should be provided in the request.

Param	Param Type	Type	Required	Description
product	body	{ productId: number }	Yes	ProductId for which offer needs to be created
yourPrice	body	Number	No (Either yourPrice or retailPrice is required)	Selling price. Commission will be applied to this price.
retailPrice	body	Number	No (Either yourPrice or retailPrice is required)	Retail Price or Buy Box Price. Commission is subtracted from this price.
cogs	body	Number	No	Cost of purchasing a single key
keys	body	array<KeyUploadType>, see KeyUploadType	No	List of Keys to be uploaded - optional
declaredStock	body	Number	No	Number of keys to sell through declared stock feature - optional

Case - Pre-Order Product

Declared stock is not available for pre-order products.

Param	Param Type	Type	Required	Description
product	body	{ productId: number }	Yes	ProductId for which offer needs to be created
yourPrice	body	Number	No (Either yourPrice or retailPrice is required)	Selling price. Commission will be applied to this price.
retailPrice	body	Number	No (Either yourPrice or retailPrice is required)	Retail Price or Buy Box Price. Commission is subtracted from this price.
cogs	body	Number	No	Cost of purchasing a single key
keys	body	array<KeyUploadType>, see KeyUploadType	No	List of Keys to be uploaded - optional
auctionedKeys	body	Number	Yes	Number of pre-orders to sell

KeyUploadType

Param	Type	Required	Description
key	string	Yes	Key in plain text or In case of image keys, Send a base64 encoded string. For more info Read RFC 2397.
name	string	Yes, in case of image key	Name of key
type	string	Yes	Key format. supported values: text, image

200

{
  "message": "string",
  "statusCode": 200,
  "offer": {
    "offerId": 0,
    "productId": 0,
    "yourPrice": 0,
    "finalSellingPrice": 0,
    "availableStock": 0
  }
}

400

{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}

401

{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}

403

{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}

500

{
    "message": "Internal Server Error",
    "statusCode": 500
}

post

/offer

Header parameters

Authorizationanyrequired

Authorization token in Bearer <token> format. Example: Bearer dvakycjgw8liyd278y

Body

one of

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://services.driffle.com/api/seller/legacy/offer' \
  --header 'Content-Type: application/json' \
  --data '{
    "yourPrice": 1,
    "retailPrice": 1,
    "cogs": 1,
    "auctionedKeys": null,
    "product": {
      "productId": 1
    },
    "keys": [
      {
        "key": "text",
        "name": "text",
        "type": "text"
      }
    ]
  }'

200

400

401

403

500

200

{
  "message": "text",
  "statusCode": 1,
  "offer": {
    "offerId": 1,
    "productId": 1,
    "yourPrice": 1,
    "finalSellingPrice": 1,
    "availableStock": 1
  }
}

Default Response