Schema representing a return. The source can be a return request originating within Spark or a return created within OpCo back-end systems.
{
"eventHeader": {
"source": "OPCO",
"version": "v1"
},
"opcoId": "BEL-CEBEO",
"accountId": "59852",
"createdDateTime": "2021-07-08T14:17:46.218772Z",
"status": "EXPECTED",
"type": "REVERSE_LOGISTICS",
"opCoReturnLineItemId": "4999569661752721026_1",
"opCoReturnLineItemReference": "4999569661752721026",
"opCoOrderIds": [
"4944452721026"
],
"product": {
"productId": "49444",
"productType": "DRUM",
"additionalInformation": [
{
"name": {
"fr-BE": "Diameter",
"nl-BE": "Diameter"
},
"value": {
"fr-BE": "1.2 m",
"nl-BE": "1.2 m"
}
}
]
},
"expectedReturnQuantity": 2,
"prices": {
"type": "CHARGE",
"netPrice": {
"amount": 4426,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 17130,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": false
}
]
},
"returnDueDate": "2023-04-12"
}
This object is used to describe some technical meta information related to the event
No Additional PropertiesThe application source of this event
The version of the json format event
Tenant identifier for an Opco in SPARK multi-tenant platform
"BEL-CEBEO"
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
"org123"
"SNE"
The opco account id of the customer.
"12345"
"12345_SNE"
The type of the return.
- REVERSE_LOGISTICS for DRUMS, PALETTES etc.
- PRODUCT for Product returns.
"REVERSE_LOGISTICS"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
The bill status of the return line item.
- INVOICED when the return line item is invoiced.
- CREDITED when the return is refund to the customer.
"INVOICED"
The invoice number in case this return was invoiced
"49995696673732721026"
The credit note number in case this return was refund to the customer
"49995696673732721026"
The unique ID of the return line item within OpCo.
This will not be displayed to the customer.
SPARK will also send this information if provided by the OpCo as part of 'EXPECTED' return information.
"4999569661752721026"
The reference of the return line item within OpCo.
This field's value will be displayed to the customer.
"4999569661752"
The list of Order Ids as generated by the OpCo to which the return is associated
Must contain a minimum of 1 items
[
"49995696673732721026",
"49995696_ORG1"
]
The status of the return line item.
- EXPECTED when the line item is an expected return by the OpCo e.g. reverse logistic items.
- REQUESTED when the return is requested by the customer.
- RETURNED when the line item is returned in full by the customer.
- DELETED when the line item is to be deleted
"EXPECTED"
The date when the return line item is created. This date/time should not be in future.
"2022-10-12T08:30:22.804Z"
Represents the product information contained within the return line item
No Additional PropertiesProduct Id of the product within the return line item
"999996966175272"
The type of the product for which return is raised.
"DRUM"
Any additional information related to the product
No Additional ItemsA free key value pair field to add any details about the product
The name or identifier for the additional information
{
"en-GB": "Diameter",
"fr-FR": "Diamètre"
}
Each additional property must conform to the following schema
Type: stringThe value for the named additional information
{
"en-GB": "1.2 m",
"fr-FR": "1.2 mètre"
}
Each additional property must conform to the following schema
Type: stringExpected return quantity of the item. Only applicable for returns of type REVERSE_LOGISTICS.
Value must be greater or equal to 1
10
Returned quantity of the item as received by the OpCo
Value must be greater or equal to 1
10
Contains the detail of prices related to the product and return line item
No Additional PropertiesThe type of the price associated with the return.
following type are possible:
- CHARGE represents the price amount that will be charged to the customer if they do not return the logistic items. This will not be applicable for Product returns initiated by the customer.
- REFUND represents the price amount that will be refunded.
This is the unit price of the product within the line item, without taxes.
No Additional Properties{
"amount": 1000,
"scale": 2,
"currency": "EUR"
}
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
This is the total price of the line item, netPrice x expectedReturnQuantity or netPrice x requestedReturnQuantity
No Additional Properties{
"amount": 2000,
"scale": 2,
"currency": "EUR"
}
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
List of taxes that will be applied to the net price
No Additional Itemscontains the tax information either as a percentage or exact amount. If percentage is sent by the OpCo, then the same percentage value will be displayed to the Customer instead of the tax amount.
A tax with a fix amount
Represents the amount information for the return line item based on the type of return
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
type of tax which is applicable to the associated net price.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
A tax represented by a percentage.
the percentage of the net price
20.0
type of tax which is applicable to the associated net price
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
[
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
},
{
"type": "ECOTAX",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": true
}
]
Contains the details of the return request as provided by the customer
No Additional PropertiesUnique identifier that represents the return request by the customer
"ref393828202"
Quantity of the item as provided in the return request by the customer.
Value must be greater or equal to 1
10
Preferred collection details provided by the Customer as part of the return request.
This should be provided by the OpCo if it was included in the return request from SPARK.
The preferred collection start date by the customer for the return line item. This date should be in future.
"2023-04-12"
The preferred collection end date by the customer for the return line item. This date should be in future and should be equal or greater than the preferred collection start date.
"2023-04-20"
Message provided by the customer during the creation of return request.
"Product no longer required, pickup from the original delivery address."
The date by when the return is due by the customer. Applicable for returns of type REVERSE_LOGISTICS.
"2023-04-12"
{
"eventHeader": {
"source": "SPARK",
"version": "v2"
},
"opcoId": "BEL-CEBEO",
"accountId": "12345",
"returnLineItems": [
{
"type": "PRODUCT",
"status": "EXPECTED",
"createdDateTime": "2022-10-12T08:30:22.804Z",
"product": {
"productId": "999996966175272",
"productType": "DRUM",
"additionalInformation": [
{
"name": {
"en-GB": "Diameter",
"fr-FR": "Diamètre"
},
"value": {
"en-GB": "1.2 m",
"fr-FR": "1.2 mètre"
}
}
]
},
"prices": {
"type": "CHARGE",
"netPrice": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2000,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
}
]
}
},
{
"type": "REVERSE_LOGISTICS",
"status": "REQUESTED",
"createdDateTime": "2022-10-12T08:30:22.804Z",
"product": {
"productId": "999996966175273",
"productType": "BOX",
"additionalInformation": [
{
"name": {
"en-GB": "Weight",
"fr-FR": "Poids"
},
"value": {
"en-GB": "5 kg",
"fr-FR": "5 kilogrammes"
}
}
]
},
"prices": {
"type": "CHARGE",
"netPrice": {
"amount": 500,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "ECOTAX",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": true
}
]
}
}
]
}
This object is used to describe some technical meta information related to the event
No Additional PropertiesThe application source of this event
The version of the json format event
Tenant identifier for an Opco in SPARK multi-tenant platform
"BEL-CEBEO"
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
"org123"
"SNE"
The opco account id of the customer.
"12345"
"12345_SNE"
List of return line items
Must contain a minimum of 1 items
The type of the return.
- REVERSE_LOGISTICS for DRUMS, PALETTES etc.
- PRODUCT for Product returns.
"REVERSE_LOGISTICS"
The unique ID of the return line item within OpCo.
This will not be displayed to the customer.
SPARK will also send this information if provided by the OpCo as part of 'EXPECTED' return information.
"4999569661752721026"
Represents the product information contained within the return line item
No Additional PropertiesProduct Id of the product within the return line item
"999996966175272"
The type of the product for which return is raised.
"DRUM"
Any additional information related to the product
No Additional ItemsA free key value pair field to add any details about the product
The name or identifier for the additional information
{
"en-GB": "Diameter",
"fr-FR": "Diamètre"
}
Each additional property must conform to the following schema
Type: stringThe value for the named additional information
{
"en-GB": "1.2 m",
"fr-FR": "1.2 mètre"
}
Each additional property must conform to the following schema
Type: stringThe list of Order Ids as generated by the OpCo to which the return is associated
Must contain a minimum of 1 items
[
"49995696673732721026",
"49995696_ORG1"
]
The status of the return line item.
- EXPECTED when the line item is an expected return by the OpCo e.g. reverse logistic items.
- REQUESTED when the return is requested by the customer.
- RETURNED when the line item is returned in full by the customer.
- DELETED when the line item is to be deleted
"EXPECTED"
The date when the return line item is created. This date/time should not be in future.
"2022-10-12T08:30:22.804Z"
Expected return quantity of the item. Only applicable for returns of type REVERSE_LOGISTICS.
Value must be greater or equal to 1
10
Returned quantity of the item as received by the OpCo
Value must be greater or equal to 1
10
Contains the detail of prices related to the product and return line item
No Additional PropertiesThe type of the price associated with the return.
following type are possible:
- CHARGE represents the price amount that will be charged to the customer if they do not return the logistic items. This will not be applicable for Product returns initiated by the customer.
- REFUND represents the price amount that will be refunded.
This is the unit price of the product within the line item, without taxes.
No Additional Properties{
"amount": 1000,
"scale": 2,
"currency": "EUR"
}
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
This is the total price of the line item, netPrice x expectedReturnQuantity or netPrice x requestedReturnQuantity
No Additional Properties{
"amount": 2000,
"scale": 2,
"currency": "EUR"
}
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
List of taxes that will be applied to the net price
No Additional Itemscontains the tax information either as a percentage or exact amount. If percentage is sent by the OpCo, then the same percentage value will be displayed to the Customer instead of the tax amount.
A tax with a fix amount
Represents the amount information for the return line item based on the type of return
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
type of tax which is applicable to the associated net price.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
A tax represented by a percentage.
the percentage of the net price
20.0
type of tax which is applicable to the associated net price
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
[
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
},
{
"type": "ECOTAX",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": true
}
]
Contains the details of the return request as provided by the customer
No Additional PropertiesUnique identifier that represents the return request by the customer
"ref393828202"
Quantity of the item as provided in the return request by the customer.
Value must be greater or equal to 1
10
Preferred collection details provided by the Customer as part of the return request.
This should be provided by the OpCo if it was included in the return request from SPARK.
The preferred collection start date by the customer for the return line item. This date should be in future.
"2023-04-12"
The preferred collection end date by the customer for the return line item. This date should be in future and should be equal or greater than the preferred collection start date.
"2023-04-20"
Message provided by the customer during the creation of return request.
"Product no longer required, pickup from the original delivery address."
The date by when the return is due by the customer. Applicable for returns of type REVERSE_LOGISTICS.
"2023-04-12"
This object is used to describe some technical meta information related to the event
No Additional PropertiesThe application source of this event
The version of the json format event
Tenant identifier for an Opco in SPARK multi-tenant platform
"BEL-CEBEO"
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
"org123"
"SNE"
The opco account id of the customer.
"12345"
"12345_SNE"
The date when the return was created. This date/time should not be in future.
"2022-10-12T08:30:22.804Z"
The date when the return was last modified. This date/time should not be in future.
"2022-10-12T08:30:22.804Z"
The list of contributors to the return request.
Must contain a minimum of 1 items
[
{
"fullName": "John Smith",
"email": "john.smith@mycompany.com"
},
{
"fullName": "John Validator",
"email": "john.validator@mycompany.com"
}
]
The full name of a contributor.
Must be at least 1 characters long
"John Smith"
The email of a contributor. This is the identifier of the user on spark
"john.smith@mycompany.com"
The phone number of a contributor.
Must be at least 1 characters long
"+1234567890"
Indicates if the contributor is the creator of the return request.
true
The unique identifier of the return as generated by the master system.
Must be at least 1 characters long
"123456789"
A referenece id for the return request in the OpCo system.
Must be at least 1 characters long
"123456789"
The return unique identifier as generated by the OpCo system
Must be at least 1 characters long
"123456789"
Contains the logistic details.
No Additional PropertiesIf the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"DROP_OFF"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"PICK_UP"
The facility id used for drop off.
Must be at least 1 characters long
"1234567"
The address used for pickup.
No Additional PropertiesOpCo internal system's unique identifier for the address.
Must be at least 1 characters long
"237564557868778"
The first line of the address. Should contain Street name, no, street type. Usually the whole address can fit on one line.
Must be at least 1 characters long
"235 Donaghy Ave"
The second line of the address. Should complete the address with other details (e.g. floor number)
Must be at least 1 characters long
"1st floor"
The third line of the address. Should complete the address with other information. e.g. Apartment no
Must be at least 1 characters long
"Apt 1"
The postal code
Must be at least 1 characters long
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
Must be at least 1 characters long
"North Vancouver"
The region in which the locality is, and which is in the country.
Must be at least 1 characters long
"BC"
The department in which the locality is, and which is in the country.
Must be at least 1 characters long
"BC"
The ISO 3166-1 alpha-3 of the country
Must be at least 1 characters long
"CAN"
The unique identifier of the return as generated by the master system.
Must be at least 1 characters long
"123456789"
Contact information of the facility.
No Additional PropertiesPhone number of the contact.
Must be at least 1 characters long
"+12345678910"
The email of the contact. This is the identifier of the user on spark
"user@domain.com"
The fax number of the contact.
Must be at least 1 characters long
"+12345678910"
List of return request line items
Must contain a minimum of 1 items
The line of the return request.
No Additional PropertiesThe unique identifier of the sales order.
Must be at least 1 characters long
"1234567"
The unique identifier of the sales order line.
Must be at least 1 characters long
"1234567"
The unique identifier of the billing.
Must be at least 1 characters long
"1234567"
The unique identifier of the billing line.
Must be at least 1 characters long
"1234567"
The product subject to this request.
No Additional PropertiesThe unique identifier of the product.
Must be at least 1 characters long
"1234567"
The name of the product.
Must be at least 1 characters long
"Product Name"
The name of the brand.
Must be at least 1 characters long
"Brand Name"
The list of images of the product.
No Additional ItemsThe image of the product.
No Additional PropertiesThe name of the image.
Must be at least 1 characters long
"Image Name"
The URL of the image.
"https://example.com/image.jpg"
A comment related to the product.
Must be at least 1 characters long
"Product Comment"
From the list of reasons configured for the OpCo.
"RECEIVED_INCOMPLETE_PACK"
Any additional information related to the product
No Additional ItemsA free key value pair field to add any details about the product
The name or identifier for the additional information
{
"en-GB": "Diameter",
"fr-FR": "Diamètre"
}
Each additional property must conform to the following schema
Type: stringThe value for the named additional information
{
"en-GB": "1.2 m",
"fr-FR": "1.2 mètre"
}
Each additional property must conform to the following schema
Type: stringThe list of notes related to the return request line.
No Additional ItemsThe severity of the note.
"INFO"
The message of the note.
{
"fr-BE": "Ceci est un message.",
"nl-BE": "Dit is een bericht."
}
Each additional property must conform to the following schema
Type: stringThe status of the return line item.
- EXPECTED when the line item is an expected return by the OpCo e.g. reverse logistic items.
- REQUESTED when the return is requested by the customer.
- RETURNED when the line item is returned in full by the customer.
- DELETED when the line item is to be deleted
"EXPECTED"
The quantity of the product returned by the customer.
Value must be greater or equal to 0
10
The type of the price associated with the return.
following type are possible:
- CHARGE represents the price amount that will be charged to the customer if they do not return the logistic items. This will not be applicable for Product returns initiated by the customer.
- REFUND represents the price amount that will be refunded.
This is the unit price of the product within the line item, without taxes.
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
This is the total price of the line item, netPrice x expectedReturnQuantity or netPrice x requestedReturnQuantity
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
List of taxes that will be applied to the net price
No Additional Itemscontains the tax information either as a percentage or exact amount. If percentage is sent by the OpCo, then the same percentage value will be displayed to the Customer instead of the tax amount.
A tax with a fix amount
Represents the amount information for the return line item based on the type of return
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
type of tax which is applicable to the associated net price.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
A tax represented by a percentage.
the percentage of the net price
20.0
type of tax which is applicable to the associated net price
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice before applying Tax. The Tax computation happens on top of netPrice + surcharges
true
[
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
},
{
"type": "ECOTAX",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": true
}
]
List of fees that mught apply (e.g. handling fee)
No Additional ItemsRepresents the amount information for the return line item based on the type of return
No Additional Propertiesthe actual unscaled amount
205987
the scale to be applied on the unscaled amount
2
the currency code following the ISO 4217 standard 3 letter in which the prices should be displayed
"EUR"
The unique identifier of the shipment associated with the return line item.
Must be at least 1 characters long
"1234567"
The sales representative information.
No Additional Propertiesfirstname of the sale representative
Must be at least 1 characters long
"John"
lastname of the sale representative
Must be at least 1 characters long
"Doe"
phone number of the sale representative
Must be at least 1 characters long
"0683906389"
email of the sale representative
Must be at least 1 characters long
"john.doe@standelec.com"