Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Customer credit note configuration

This event tracks changes to customer credit note configurations, including creation and updating. It provides essential information about the configuration and the action performed.

Events

application/customer_credit_note_configuration/create/v1

# This event is triggered when a customer credit note configuration is created. It contains details about the configuration and the action performed.

application/customer_credit_note_configuration/update/v1

# This event is triggered when a customer credit note configuration is updated. It contains details about the configuration and the action performed.

Customer Credit Note Configuration/customer_credit_note_configuration/create/v1

This event is triggered when a customer credit note configuration is created. It contains details about the configuration and the action performed.

Payload

Properties

Event emitted when a customer credit note configuration is changed.

application_id

array|string

Required

Sales channel ID for which this event is triggered

company_id

integer

Required

The unique identifier of the company.

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

The category of the event, e.g., whether it is at sales channel level or company level.

created_timestamp

integer

Required

Event generation timestamp in epoch milliseconds.

string

Required

Unique ID for the event, which can be used to verify if the event has already been processed by the 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.

version

string

Required

Version of the event.

payload

object

Required

Payload associated with the event.

Properties

company_id

integer

Required

The unique identifier of the company.

affiliate_id

string

Required

Affiliate ID associated with the configuration.

is_active

boolean

Required

Indicates whether the configuration is active.

is_cn_as_refund_method

boolean

Required

Indicates whether the CN is used as a refund method.

validity

integer

Required

Credit note expiry period in days.

issuance_ordering_channels

array of

Required

Channel through which orders are placed.

redemption_ordering_channels

array of

Required

Source channel for the configuration.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "description": "Event emitted when a customer credit note configuration is changed.",
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "The unique identifier of the company."
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object.",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "description": "The category of the event, e.g., whether it is at sales channel level or company level."
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds."
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for the event, which can be used to verify if the event has already been processed by the receiver."
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event."
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace ID for Fynd Platform services.",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event, e.g., create/update."
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "description": "Payload associated with the event.",
78      "required": [
79        "company_id",
80        "affiliate_id",
81        "is_active",
82        "is_cn_as_refund_method",
83        "validity",
84        "issuance_ordering_channels",
85        "redemption_ordering_channels"
86      ],
87      "properties": {
88        "company_id": {
89          "type": "integer",
90          "description": "The unique identifier of the company."
91        },
92        "affiliate_id": {
93          "type": "string",
94          "description": "Affiliate ID associated with the configuration."
95        },
96        "is_active": {
97          "type": "boolean",
98          "description": "Indicates whether the configuration is active."
99        },
100        "is_cn_as_refund_method": {
101          "type": "boolean",
102          "description": "Indicates whether the CN is used as a refund method."
103        },
104        "validity": {
105          "type": "integer",
106          "description": "Credit note expiry period in days."
107        },
108        "issuance_ordering_channels": {
109          "type": "array",
110          "description": "Channel through which orders are placed."
111        },
112        "redemption_ordering_channels": {
113          "type": "array",
114          "description": "Source channel for the configuration."
115        }
116      }
117    }
118  }
119}

Payload Example

1{
2  "description": "Example of a create event for customer credit note configuration",
3  "value": {
4    "event": {
5      "name": "customer_credit_note_configuration",
6      "type": "create",
7      "version": "v1",
8      "created_timestamp": 1726560641,
9      "id": "16094052fe3101e7b32b7c4f90348b7a",
10      "category": "company",
11      "trace_id": [
12        "16094052fe3101e7b32b7c4f90348b7a"
13      ]
14    },
15    "contains": [
16      "company_id",
17      "affiliate_id",
18      "is_active",
19      "is_cn_as_refund_method",
20      "validity",
21      "issuance_ordering_channels",
22      "redemption_ordering_channels"
23    ],
24    "payload": {
25      "company_id": 661,
26      "affiliate_id": "649c1abece3fb4af7362edcd",
27      "is_active": true,
28      "is_cn_as_refund_method": true,
29      "validity": 100,
30      "issuance_ordering_channels": [
31        "platform-pos"
32      ],
33      "redemption_ordering_channels": [
34        "platform-pos"
35      ]
36    }
37  }
38}

Customer Credit Note Configuration/customer_credit_note_configuration/update/v1

This event is triggered when a customer credit note configuration is updated. It contains details about the configuration and the action performed.

Payload

Properties

Event emitted when a customer credit note configuration is changed.

application_id

array|string

Required

Sales channel ID for which this event is triggered

company_id

integer

Required

The unique identifier of the company.

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

The category of the event, e.g., whether it is at sales channel level or company level.

created_timestamp

integer

Required

Event generation timestamp in epoch milliseconds.

string

Required

Unique ID for the event, which can be used to verify if the event has already been processed by the 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.

version

string

Required

Version of the event.

payload

object

Required

Payload associated with the event.

Properties

company_id

integer

Required

The unique identifier of the company.

affiliate_id

string

Required

Affiliate ID associated with the configuration.

is_active

boolean

Required

Indicates whether the configuration is active.

is_cn_as_refund_method

boolean

Required

Indicates whether the CN is used as a refund method.

validity

integer

Required

Credit note expiry period in days.

issuance_ordering_channels

array of

Required

Channel through which orders are placed.

redemption_ordering_channels

array of

Required

Source channel for the configuration.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "description": "Event emitted when a customer credit note configuration is changed.",
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "The unique identifier of the company."
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object.",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "description": "The category of the event, e.g., whether it is at sales channel level or company level."
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds."
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for the event, which can be used to verify if the event has already been processed by the receiver."
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event."
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace ID for Fynd Platform services.",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event, e.g., create/update."
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "description": "Payload associated with the event.",
78      "required": [
79        "company_id",
80        "affiliate_id",
81        "is_active",
82        "is_cn_as_refund_method",
83        "validity",
84        "issuance_ordering_channels",
85        "redemption_ordering_channels"
86      ],
87      "properties": {
88        "company_id": {
89          "type": "integer",
90          "description": "The unique identifier of the company."
91        },
92        "affiliate_id": {
93          "type": "string",
94          "description": "Affiliate ID associated with the configuration."
95        },
96        "is_active": {
97          "type": "boolean",
98          "description": "Indicates whether the configuration is active."
99        },
100        "is_cn_as_refund_method": {
101          "type": "boolean",
102          "description": "Indicates whether the CN is used as a refund method."
103        },
104        "validity": {
105          "type": "integer",
106          "description": "Credit note expiry period in days."
107        },
108        "issuance_ordering_channels": {
109          "type": "array",
110          "description": "Channel through which orders are placed."
111        },
112        "redemption_ordering_channels": {
113          "type": "array",
114          "description": "Source channel for the configuration."
115        }
116      }
117    }
118  }
119}

Payload Example

1{
2  "description": "Example of a create event for customer credit note configuration",
3  "value": {
4    "event": {
5      "name": "customer_credit_note_configuration",
6      "type": "create",
7      "version": "v1",
8      "created_timestamp": 1726560641,
9      "id": "16094052fe3101e7b32b7c4f90348b7a",
10      "category": "company",
11      "trace_id": [
12        "16094052fe3101e7b32b7c4f90348b7a"
13      ]
14    },
15    "contains": [
16      "company_id",
17      "affiliate_id",
18      "is_active",
19      "is_cn_as_refund_method",
20      "validity",
21      "issuance_ordering_channels",
22      "redemption_ordering_channels"
23    ],
24    "payload": {
25      "company_id": 661,
26      "affiliate_id": "649c1abece3fb4af7362edcd",
27      "is_active": true,
28      "is_cn_as_refund_method": true,
29      "validity": 100,
30      "issuance_ordering_channels": [
31        "platform-pos"
32      ],
33      "redemption_ordering_channels": [
34        "platform-pos"
35      ]
36    }
37  }
38}

« courier-partner/assign/v1

customfield_definition/create/v1 »