Help Center

Order Sync Destination: GoDataFeed API

GoDataFeed API Integration
GoDataFeed API Integration
  • Updated

GoDataFeed's API may be used to integrate Order Sync with your custom platform. Please access our developer documentation here.

_CustomFeed.svg API Reference

GoDataFeed API Documentation

Authorization

GoDataFeed uses Tokens to allow access to the API. In order to obtain authorization to use the GoDataFeed API, you need to first setup a Consumer Key in the GoDataFeed App. The Consumer Key is used to generate Access Tokens that are then used in all subsequent API calls.

To create a token, make a call to the get authorization endpoint with your consumer key

https://api.godatafeed.com/v1/authorization

Best Practices

1. Generate 'tokens' once or as often as desired

Consumer keys can be set to expire tokens (lifespan) with the following options: “Never Expires”, “7 Days”, “14 Days” and “30 Days”.

It’s important to note that the developer of the consuming application has the option of generating access tokens as frequently as needed (once an hour, once a day, etc.); the more frequent a token is refreshed the more secure the consuming application will be.

You can set the tokens to never expire and generate the token manually once to be used for your application. Or, you can set the expiration to "7 days" use the authorization request regularly in your application, like every time a request is made.

2. Retrieve 'NEW' orders regularly and often

Get new orders to insert into the order management platform from which orders are fulfilled.

Our system runs sync cycles in which new marketplace orders are imported into our app every 15-30 minutes. You do not need to query for new orders more often than every few minutes.

3. Acknowledge 'NEW' orders after inserting them into the destination

The most important reasons to acknowledge orders is because marketplaces may not update available quantity until you have acknowledge an order to be fulfilled. Before acknowledging an order, the seller has an opportunity to cancel the order because it is not available or for other reasons. Then the item available quantity will be adjusted by the marketplace so that it may be purchased by another buyer.

As long as you acknowledge orders which have been successfully inserted into the destination order management platform, then you can confidently query for only new orders that have not been inserted using the status=NEW filter parameter.

Include the destination (seller's) order number in the acknowledgement. This tells our system, "yes, we got the order and our system has assigned this order an id from the seller's fulfillment system". Our system will then acknowledge the order and send the seller order number back to the marketplace.

4. Update orders as 'SHIPPED' regularly and often with specific date time

Once an order is shipped, update the status of the order to shipped, include the tracking number and be sure to use the date AND time the order was shipped. If you do not know the ship date, then you could use current dateTime. If you only include the date, then our system defaults the time to midnight. This can cause errors if an order was purchased and shipped the same day.

5. 'CANCEL' orders as needed using the Update Order Status request

If an order cannot be fulfilled because it is out of stock or for other reasons, then update the order as cancelled.

Some marketplaces accept a reason for cancelling an order, but our system only supports hard coded reasons which are set within the system and cannot be set by the Update Order Status request.

Order Sync Lifecycle

This graphic illustrates the flow of an order from the marketplace until it is sync complete in our system.

Order_Sync_Lifecycle.svg

See also the attached .pdf version.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.