This page provides a comprehensive guide to the Order Processing API, which allows you to integrate order management into your application.

Overview

The Order Processing API is designed to handle various order-related operations, such as creating, updating, and retrieving orders. It provides a seamless way to manage your e-commerce orders efficiently.

Endpoints

Create Order

To create a new order, you can use the /create-order endpoint. Here are the required parameters:

  • order_id: A unique identifier for the order.
  • customer_id: The ID of the customer placing the order.
  • items: An array of items included in the order, with each item containing item_id, quantity, and price.

For example:

{
  "order_id": "12345",
  "customer_id": "67890",
  "items": [
    {
      "item_id": "item1",
      "quantity": 2,
      "price": 10.99
    },
    {
      "item_id": "item2",
      "quantity": 1,
      "price": 5.99
    }
  ]
}

Update Order

You can update an existing order using the /update-order endpoint. The required parameters are order_id and the fields you want to update.

For example:

{
  "order_id": "12345",
  "status": "shipped"
}

Retrieve Order

To retrieve an order, use the /retrieve-order endpoint and provide the order_id.

For example:

GET /retrieve-order?order_id=12345

Usage

To use the Order Processing API, you need to authenticate with your API key. Include the Authorization header with your request:

Authorization: Bearer <your_api_key>

For more information on obtaining an API key, please visit our API Key Management page.

Additional Resources

Order Processing