Integrating Codept into your operations flow
To get all the advantages of using Codept, we recommend making it a part of your operations flow by integrating our API and the processing of Codept messages.
How to integrate the Codept API#
The Codept API is the primary way to benefit from Codept functionality. The API is designed to be used directly in your logistics processing systems, for example:
- In your orders application:
- to create a sales order in your system based on a customer's order
- to create a purchase order as a process of acquiring storage space in specific warehouse
- to be notified when warehouse receives your sales order
- to be notified when warehouse ships your sales order
- In your returns processing application: to create a return notification.
- In your shipment tracking system:
- to visualize an order's delivery state for an end user
- to be notified when carrier delivers parcel to customer
- To keep track of current stock quantities for all your integrated warehouses
Codept currently supports using its REST API via the HTTPS protocol. If you are planning to use the Codept API in multiple applications, we recommend creating a wrapper in your programming language of choice, which should simplify the integration of the Codept API into multiple systems.
You can find the details on all available API endpoints in the Getting Started with the Codept API section.
How to integrate Codept message processing#
The Codept system generates messages to inform you of the changes in your orders' state. Some example uses for Codept system messages:
- Send transactional emails to your customers when their order has been shipped.
- Update counters/database entries in your database of all canceled orders kept for reporting purposes.
The messages are sent in webhook format to an endpoint that can be configured in your Codept settings. To integrate Codept messages into your operations flow, you’ll need to establish an endpoint to receive the messages, then perform the actions corresponding to each message type as they arrive.
We recommend storing all the webhooks you receive from Codept in a queue system in order to ensure Codept messages don’t overload your system and, in case of an outage, to ensure no message is lost.
You can see the types of messages that Codept supports and the specifics of their format in the Messages section of the Fulfillment Merchant API, Shipment Merchant API or the Warehouse API documents.