Workflow description:
When a B2B ticket on Claimlane is moved to a specific status (e.g., "Ready for ERP"), it becomes eligible for ERP processing and is ready for Credit Memo creation.
The ERP system polls Claimlane for such tickets using the following endpoint:
These are the required parameters that will identify what tickets are eligible to be polled:
brandId - ID for the brand. This will be given by Claimlane. brandId can be obtained using the endpoint
/v2/company/supplierswith a company api key or/v2/brandswith a supplier api keyclaimboxStatusId - ID for the status on Claimlane (e.g., "Ready for ERP") that determines whether the ticket is eligible to be process in the ERP. This will be provided by Claimlane during account setup.
supplierintegrationComplete - Allows the ERP to query only tickets that have not yet been handled already by setting supplierintegrationComplete: 0
Example request:
https://server-claimlane.claimlane.com/api/v2/company/b2b-tickets?brandId={brandId}&claimboxStatusId={claimboxStatusId}&supplierintegrationComplete=0where {brandId} and {claimboxStatusId} are uuid's provided by Claimlane.To integrate with the ERP system, pull the following key fields from Claimlane:
id // if of the ticket
retailer.customerNumber // customer number of the retailer who created the ticket
claimProducts {
productIds[] // The id of the product to be refunded, use first element
quantity // The number of products to be refunded for this productId
}[] // List of products to be refundedOnce the ERP has created the Credit Memo, it must notify Claimlane by updating the ticket using this endpoint:
With the following body
{
"supplierIntegrationComplete": true,
"isClosed": true
}"supplierIntegrationComplete": true
This will stop the ticket from getting polled again, as it has been resolved.
"isClosed": true
A ticket on Claimlane will get “Archived” so it shows to Customer Service that the action has been done on the ERP and the ticket doesn’t require any further attention.
Please see full API documentation here: