The order endpoint should be a REST API delivering order and product data. Claimlane will call this endpoint when a customer is creating a ticket. The endpoint should accept two values, for example email and order number.
All data provided by this endpoint will be carried through Claimlane and can be used by later API's for example for refunds, shipping etc.
Claimlane supports a standard order integration data model that can be found here:
https://server-claimlane.claimlane.com/api-docs/#/callbacks/b2c-order-integration
You can also follow a different data model if that is easier for you in which case we will have to build a mapper on our side.
Examples of other data models can be found below.
<aside> 💡 Example endpoint
GET <https://api.claimlane.com/order?orderNumber={ORDER_NUMBER}&email={EMAIL}>
</aside>
<aside> 💡 Example data model 1
{
order: {
// Order info
orderDate: string;
deliveryDate: string;
orderNumber: string;
invoiceNumber: string;
customerNumber: string;
customerEmail: string;
// Address and delivery
billingAddressName: string;
billingAddressPhoneNumber: string;
billingAddress: string;
billingAddressZipCode: string;
billingAddressCity: string;
billingAddressCountry: string;
billingAddressCvrNo: string;
billingAddressAtt: string;
deliveryAddressName: string;
deliveryAddress: string;
deliveryAddressCity: string;
deliveryAddressZipCode: string;
deliveryAddressPhoneNumber: string;
deliveryAddressCountry: string;
shippingWeight: number;
},
products: [{
// Product info
productId: string; // REQUIRED
productName: string; // REQUIRED
productUnitPrice: number;
productQuantity: number;
productDescription: string;
productCategory: string;
productSku: string;
productUrl: string;
productEan: string;
productImageUrl: string;
productDeliveryTime: string;
// Supplier information
supplierName: string;
supplierNumber: string;
supplierSku: string;
}]
}
</aside>
<aside> 💡 Example data model 2
{
products: [{
// Order info
orderDate: string;
deliveryDate: string;
orderNumber: string;
invoiceNumber: string;
customerNumber: string;
customerEmail: string;
// Address and delivery
billingAddressName: string;
billingAddressPhoneNumber: string;
billingAddress: string;
billingAddressZipCode: string;
billingAddressCity: string;
billingAddressCountry: string;
billingAddressCvrNo: string;
billingAddressAtt: string;
deliveryAddressName: string;
deliveryAddress: string;
deliveryAddressCity: string;
deliveryAddressZipCode: string;
deliveryAddressPhoneNumber: string;
deliveryAddressCountry: string;
shippingWeight: number;
// Product info
productId: string; // REQUIRED
productName: string; // REQUIRED
productUnitPrice: number;
productQuantity: number;
productDescription: string;
productCategory: string;
productSku: string;
productUrl: string;
productEan: string;
productImageUrl: string;
productDeliveryTime: string;
// Supplier information
supplierName: string;
supplierNumber: string;
supplierSku: string;
}]
}
</aside>