Skip to main content

Acenda API v3.1 Guide

S
Written by Sam E.
Updated this week

Acenda API v3.1 Guide

Welcome to the Acenda API. This guide provides the essential information you need to start integrating with our platform.


1. API Endpoint

Your primary endpoint for accessing the Acenda catalog API is:

All API requests should be directed to this URL.


2. API Documentation πŸ“„

For comprehensive details on all available endpoints, request methods, parameters, and example responses, please refer to our official Postman documentation.

Important Note: In Acenda, what are commonly known as "orders" are referred to as Ship Advice. This is because a single customer order may be split into multiple Ship Advices if items are fulfilled from different warehouses.


3. Getting Your API Key πŸ”‘

To authenticate your requests, you will need an API key. Follow these steps to obtain your key:

  1. Log in to your Acenda admin panel.

  2. Navigate to Users > API Keys.

  3. Generate a new API key.

Best Practice: If you are working with outside contractors or third-party developers, we strongly recommend creating unique API keys for each partner. This enhances security and allows for better management of API access.


4. Example Workflow: Handling Ship Advices πŸ“¦

Here is a common workflow for retrieving and processing new orders (Ship Advices).

i. Get New Ship Advices

To get new, unacknowledged Ship Advices for your store, perform a GET request to the ship_advice endpoint. You'll need to pass your API token and the x-astur-organization as headers, as documented here.

A properly formatted call for your store, filtering for fulfillment_provider_id: 1 and warehouses: 1,2,3,4, will look like this:

The unacked=true parameter is crucial as it ensures you only pull Ship Advices that you have not yet processed.

ii. Acknowledge the Ship Advice

Once you have successfully received a Ship Advice in your system, you must acknowledge it. This removes it from the queue of unacknowledged Ship Advices for your next API call.

iii. Add Tracking Information

After you have fulfilled the Ship Advice, the final step is to add the tracking number back into Acenda.

Did this answer your question?