ERP integration playbook for synchronizing cancellations
NewStore allows you to create financial transactions in an ERP system and sync them with NewStore Omnichannel Cloud for all order cancellations.
This integration playbook helps you integrate an ERP system used in your business with the NewStore platform, to sync all order cancellations. The integration is achieved via the Event Stream .
For each order placed in NewStore Omnichannel Cloud that is canceled, a credit-memo transaction is created in the ERP, which includes:
- Canceled items with prices and taxes
- Payment and invoice details of the original order
Process overview
The following sequence diagram represents a typical integration of canceled orders in NewStore Omnichannel Cloud with an ERP:
In this playbook:
- NewStore sends the
order.items_cancelled
event when order cancelation has been completed. - The integration fetches all necessary details via
graphql
. Payments are processed asynchronously, therefore it may take some time until all payment details are available. - The integration requests for the details of the original sales order by calling the NetSuite Web Services.
- The integration requests for the details of the invoice of the original sales order by calling the NetSuite Web Services.
- The integration creates the credit memo transaction in the ERP by calling the ERP's API.
Exceptions
ERP unavailable
The integration returns a 500 error, and the Event stream retries sending the macro event.
Payment details unavailable
In some cases, it takes more than a few seconds until payment processing
at the PSP
has been completed and the payment details become available
in the platform. The integration moves the event into an internal queue
(for example, SQS) for to reprocess later, and returns 200
.
Sample GraphQL Query
Here is an example GraphQL query to retrieve all the information required to create a credit memo transaction in the ERP.
query MyQuery {
order(id: "012345Ab-CdEf-GhIj-KlMn-OpQrStUvWxYz", tenant: "dodici") {
externalId
placedAt
demandLocationId
currency
isExchange
isHistorical
channel
channelType
shippingTax
shippingTotal
taxExempt
taxStrategy
taxTotal
subtotal
grandTotal
discounts {
edges {
node {
couponCode
}
}
}
paymentAccount {
instruments {
edges {
node {
paymentMethod
paymentOrigin
paymentProvider
paymentAccountTransactions {
edges {
node {
amount
currency
transactionType
}
}
}
}
}
}
}
items {
edges {
node {
productId
quantity
pricebookPrice
itemDiscounts
orderDiscounts
tax
shippingServiceLevel
fulfillmentLocationId
}
}
}
}
}
ERP integration example with NetSuite
For integrations with NetSuite as an ERP system for cancellations, see this example .
Related topics
- ERP integration playbook to sync returns
- ERP integration playbook to sync appeasement refunds
- ERP integration playbook to sync endless-aisle orders
- ERP integration playbook to sync in-store purchases
- ERP integration example with NetSuite for cancellations
- Integrating a payment service provider
- GraphQL API