Company

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

Courier partner

This event will be generated where there is any action done on courier-partner

Events

company/courier-partner/account-status/v1

# this event is triggered when courier-partner is account-statused

Courier Partner/courier-partner/account-status/v1

this event is triggered when courier-partner is account-statused

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

courier-partner

object

Required

Object containing the details for the courier partner including accouunt_id, extension id and such.

Properties

stage

string

Required

A string indicating current stage of account

scheme_id

string

Required

unique id of scheme

account_id

string

Required

unique id of account

extension_id

string

Required

extension api key

is_own_account

boolean

Required

Indicates whether the account belongs to the seller

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        "courier-partner"
70      ],
71      "properties": {
72        "courier-partner": {
73          "type": "object",
74          "description": "Object containing the details for the courier partner including accouunt_id, extension id and such.",
75          "required": [
76            "extension_id",
77            "scheme_id",
78            "account_id",
79            "stage",
80            "is_own_account"
81          ],
82          "properties": {
83            "stage": {
84              "type": "string",
85              "description": "A string indicating current stage of account"
86            },
87            "scheme_id": {
88              "type": "string",
89              "description": "unique id of scheme"
90            },
91            "account_id": {
92              "type": "string",
93              "description": "unique id of account"
94            },
95            "extension_id": {
96              "type": "string",
97              "description": "extension api key"
98            },
99            "is_own_account": {
100              "type": "boolean",
101              "description": "Indicates whether the account belongs to the seller"
102            }
103          }
104        }
105      }
106    }
107  }
108}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "830da154-da02-40be-b062-580c52978885"
5    ],
6    "name": "courier-partner",
7    "type": "account-status",
8    "version": "1",
9    "created_timestamp": 1712041565,
10    "id": "WPITfT3LYD9cGByJjPbRLzDsJI8Z9JYXcTzzHfdtUfU=",
11    "category": "company"
12  },
13  "company_id": 327,
14  "contains": [
15    "courier-partner"
16  ],
17  "payload": {
18    "courier-partner": {
19      "extension_id": "656f1f18c24dabc79325b1ba",
20      "scheme_id": "65952a7b199ac0fd9537b1a7",
21      "account_id": "65a69abfbae4d80f1f4294ca",
22      "stage": "disabled",
23      "is_own_account": false
24    }
25  }
26}

« company/create/v2

customfield_definition/create/v1 »