Connect Order Data

Send your customers' order data via file or API when creating a tracking or let us retrieve the order data using a real-time API connection.

Providing Order Data to parcelLab

To initiate the returns process, parcelLab will need to receive all the necessary order-related information. With the order data, we can display the purchased articles for each order, so your customers can select the items they want to return.

There are two ways you can provide the order data required for the Returns Portal to work.

1. Using outbound order data Using this method, we reference order data that is sent to parcelLab via a file or API connection for outbound trackings. We store the data for up to 90 days and reference this database whenever your customers use your Returns Portal. For more information on using this method of data transmission, please refer to the following documentation pages:

   • Creating a tracking

   • Data model

2. Using real-time API connection Using this method, we call an API endpoint the moment a customer logs into your Returns Portal. This real-time API connection ensures that the order data is up to date and stored only when necessary. This integration enables the handling of use cases that require the returns window to be longer than 90 days. For information on using this method of data transmission, please refer to the order data required section on this page.

Order Data Required

For the Returns Portal to work, we need the order data to display each customer’s purchase when they log in to your Returns Portal.

The data should include, but is not limited to:

• Order number

• Information required for customer identification (for example: email address or zip code)

• Email address to enable communication

• Personal information that should be displayed (for example: name and delivery address)

• Product information for the order

• Information used to apply rules in the returns process (for example: product categories)

The following table lists all mandatory and optional data fields that need to be provided to parcelLab using the order data transmission methods listed in the previous section.

Field	Example	Type	Necessity	Description
Order Details
orderNumber	12345678	string	mandatory	Order number.
shippingDate	2024-12-03	date	optional	Date of shipment in the format YYYY-MM-DD (ISO-8601).
orderDate	2024-12-01	date	mandatory	Date the order was made in the format YYYY-MM-DD (ISO-8601).
deliveredDate	2024-12-05	date	optional	Date of delivery in the format YYYY-MM-DD (ISO-8601).
totalOrderAmount	132.80	numeric	optional	Total amount paid by the customer for the order.
parcelDimension	20-30-15	numeric	optional	Dimensions of the parcel according to Height-Width-Depth.
paymentMethod	CreditCard	string	optional	Method of payment the customer used.
Article Details
description	Cotton Pullover	string	mandatory	Name of the item.
itemID	1223214343	string	mandatory	Unique item ID.
SKU	1312321324	string	mandatory	Unique stock keeping unit.
articleUrl	https://...com	string	mandatory	URL to the item (website).
imageUrl	https://...com	string	mandatory	URL to the image of the item.
quantity	2	numeric	mandatory	Quantity purchased.
returnableQuantity	1	numeric	optional	Quantity eligible for return.
productColor	Black	string	optional	Color of the item.
productSize	L	string	optional	Size of the item.
articlePrice	13.28	numeric	optional	Price of the item.
articleCurrrency	EUR	string	optional	Currency in which the customer paid (ISO-4217).
articleWeight	600	numeric	optional	Weight of the item in grams.
articleWidth	20	numeric	optional	Width of the item in centimeters.
articleLength	15	numeric	optional	Length or height of the item in centimeters.
articleDepth	3	numeric	optional	Depth of the item in centimeters.
productCategory	Underwear	string	optional	Product categories used for rule building and warehouse logistics.
transportType	bulkyGood	string	optional	Used for exceptions such as dangerous or bulky goods.
Customer Details
salutation	Mr.	string	optional
name	Bruce Wayne	string	mandatory
street	Rue du Chardonay	string	mandatory
zip	80039	string	mandatory
state	Île-de-France	string	optional
city	Paris	string	mandatory
country	FR	string	mandatory
phone	01569283	string	optional
email	[email protected]	string	mandatory