Company

Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.

Logistics configuration

This event will be generated where there is any logistics as per actual change in billing plan

Events

company/logistics-configuration/update/v1

# this event is triggered when logistics-configuration is updated

Logistics Configuration/logistics-configuration/update/v1

this event is triggered when logistics-configuration is updated

Payload

Properties

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

logistics

object

Required

Properties

uid

integer

Required

company unique id

logistics_as_actual

string

Required

Indicates the commercial type for logistics, i.e Admin-controlled/Self-controlled/Self-ship

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "logistics"
70      ],
71      "properties": {
72        "logistics": {
73          "type": "object",
74          "required": [
75            "uid",
76            "logistics_as_actual"
77          ],
78          "properties": {
79            "uid": {
80              "type": "integer",
81              "description": "company unique id"
82            },
83            "logistics_as_actual": {
84              "type": "string",
85              "description": "Indicates the commercial type for logistics, i.e Admin-controlled/Self-controlled/Self-ship"
86            }
87          }
88        }
89      }
90    }
91  }
92}

Payload Example

1{
2  "company_id": 3875,
3  "contains": [
4    "logistics"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1710770247,
9    "id": "SZ1niYdOONKXCx2AGs1NtQMReFnFT1SEV7BsJpY6tOw=",
10    "name": "logistics-configuration",
11    "trace_id": [
12      "5ceaa595-d387-47c1-8b40-02a9c7e46415"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "logistics": {
19      "logistics_as_actual": "self-ship",
20      "uid": 3875
21    }
22  }
23}

« location-quantity/create/v1

product/create/v3 »