1. Help Center
  2. API
  3. Generic Suppliers API

Generic Suppliers API - Events

List information about sync events from a given supplier.

All endpoints below needs a token for authentication. Please, go to this article in order to discover how to generate one.

GET /integrations/suppliers/events/

List events that happened during the sync. Check directly in the API here.

Response schema:

{
  "count": integer,
  "next": integer | null,
  "previous": integer | null,
    "results": [
        {
          "message": string,
          "created_at": string, (date time - ISO 8601 format)
          "event_type": string, ("CRITICAL" | "ERROR" | "WARNING" | "INFO")
          "customer_number": string | null,
          "third_party_id": string | null, 
          "extra_data": json | null
        }
    ]
}

Fields information:

  • customer_number -> It's the unique identifier in your system for a given customer;
  • third_party_id -> Unique identifier of a package.

Filters:

  • third_party_id -> string equality;
  • customer_number -> string equality;
  • message -> string case-insensitive;
  • event_type -> Possible values: "CRITICAL", "ERROR", "WARNING" or "INFO";
  • created_at__lte -> Filter by creation date less or equal than (date time - ISO 8601 format);
  • created_at__gte -> Filter by creation date greater or equal than (date time - ISO 8601 format).

Response example:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "message": "An error message", 
            "created_at": "2022-05-10T02:00:00+02:00", 
            "event_type": "ERROR", 
            "customer_number": null, 
            "third_party_id": "456", 
            "extra_data": null
        }
    ]
}

 

Go back: