Skip to content

FAQs

1. Do you provide a test environment to test OEA?

Connected Retail does not provide a test environment to test OEA. This is why we recommend that you test the notifications for 2 days and then enable business logic on your end.

2. How will I know if a new API configuration is available?

We will send out an email when new functionalities are added to the API. Breaking changes will be avoided in the API, however API can evolve in a backward compatible way in the future.

Examples of breaking changes which will be avoided:

  • Renaming an attribute
  • Changing the attribute type
  • Removing an attribute
  • Removing event type (for example, ‘routed’)

Examples of backward compatible changes which might happen:

  • Adding new event type with a new set of attributes
  • Adding new attributes to existing event types

Your IT systems consuming the API should be prepared for the listed backward compatible changes and handle adding new attributes and event types gracefully: a sensible implementation might be to ignore such additional attributes and event types and not be too strict about asserting which exact set of attributes is included into an event.

Filtering out certain event types is the responsibility of your system which connects to Order Events API.

3. Could I send any other response other than [200]?

HTTP statuses returned by the webhook are interpreted as defined by RFC 7231. For example, 200 means that event was successfully received, 500 that an internal server error happened, etc.

4. I don’t see the customer data in the API. Could that be sent to us to enable the picking process?

The API does not provide you the customer data for the picking process.

5. What if an order has two (or more) identical items, how will the items be reported in the hook payload?

Each item will be reported as an individual entry in the list of items.

6. What if an order has two items, one marked as not available, the other is picked, what order event will be sent at the time the order is completed in the tool?

For fulfilled order the list of items that were completed excluding cancelled items

7. What happens if my server does not accept the notifications for over 3 days?

We do not provide the notifications in bulk after 3 days. We do not provide a pull functionality to retrieve the notifications.

8. What do split order notifications look like?

A split order is when two orders have the same order number. In the case of a split order, the only difference is that multiple orders share the same order_number but nothing else. They still have different items, event id, order id.

9. What do partial cancelled order notifications look like?

Partial cancellation means that at first the store receives an “assigned” event where they can see all items for a particular order. Lets say, the store receives an order that has 2 items. When the order is partially fulfilled we only send items that were “fulfilled”. The “fulfilled” event only contains items that were fulfilled. We don't send any extra events on items that were canceled by the store.

10. Could I use the Simple Queue Service (SQS) from Amazon as a webhook URL?

Yes, you can. Since you have already set up SQS, it is possible to expose the queue through an AWS API Gateway by creating a simple API and using the API Gateway service proxy feature. API Gateway can also be secured natively with an API key. Please find some links to documentation resources below to get you going.

Official documentation on AWS API Gateway + S3
Set up API keys using the API Gateway console