Luxclusif Buyback Platform

Appearance

General Guidelines ​

OpenAPI spec ​

This documentation is a reference the resale of luxury goods via Luxclusif Buyback Platform APIs. The Platform currently allows two different flows:

  • Buyback (C2B2B): allows the creation of Trade-In programs connecting the end customers with a pool of B2B Buyers.
  • Consigment (B2B): allows the publishing of Consigment Items from B2B Suppliers.

Each flow has its dedicated sections and subsections on the left sidebar. Within the subsections, you will find either the name of an API endpoint operation or an Webhooks notification operation. For complete documentation of the API endpoints, please refer to our public OpenAPI specs:

Submission Images ​

  • Currently, Submission Images must be stored externally to the Platform and sent as urls to the POST Submission with the endpoint;

DateTime Handling ​

  • The API returns all the Dates in UTC;

Webhooks ​

  • Webhooks are currently only available for Buyback submissions;
  • All webhook notifications are sent in camelCase and will have the same base-structure with three properties:
    • type: type of the notification;
    • token: token stored in the Webhook subscription;
    • result: object containing the notification;
  • The events are triggered in the same order presented in this documentation;
  • The Buyback Platform might introduce new features/events at any time. Therefore, we strongly advise that the development of the Webhooks is based on the type property, to ensure that the correct step of the flow is triggered on the Webhook reception.

Rate-limiting mechanism ​

  • We've integrated an IP rate-limiting mechanism into our Buyback Platform APIs middleware, leveraging the 'x-real-ip' header to identify the client's IP address. To guarantee a seamless and uninterrupted experience, API tenants must include the 'x-real-ip' header in their requests, specifying the client's IP address:
    • x-real-ip: the Client IP address;