APIs for Developers

API Documentation

Welcome to the Customix Integrations API reference.

Below you'll find details on authentication, available endpoints, and examples.

🔑 Authentication

All requests require an API key in the header:

Authorization: Bearer <your_api_key>

🌐 Base URL

https://app.customix.io/api/integrations/v1

📘 Endpoints

1. Get List of Orders

Endpoint:

GET /orders

Description:

Fetch list of orders

Path Parameters:

Parameter	Type	Required	Description
`shop`	string	✅	Shopify store name. If your store url is abcdef.myshopify.com, then shop=abcdef
`limit`	integer	⬜	default is 50, maximum value is 250
`created_at_min`	date	⬜	Show orders created at or after date (format: 2025-01-21)
`created_at_max`	date	⬜	Show orders created at or before date (format: 2025-01-30)
`order_status`	string	⬜	created: Show only open orders. paid: Show only paid orders. fulfilled: Show only fulfilled orders.

Headers:

Header	Value
`Authorization`	Bearer API_KEY

Request Body:

{
  "shop": "abcdef.myshopify.com",
  "limit": 2
}

Response:

[{
  "shop": "abcdef.myshopify.com",
  "order_id": 123456789,
  "order_number": "123",
  "currency": "USD",
  "customer": "John Doe",
  "email": "john@example.com",
  "ip": "123.123.123.123",
  "total_price": 123.45,
  "financial_status": "paid",
  "fulfillment_status": "fulfilled",
  "ordered_at": "2025-01-21 01:01:01",
  "customizations": [
        {
          "id": "01jjavmg7t7vqj5z6qvxwie14b",
          "campaign_id": "01jphjdfmtxhaio94h0wd0kv0c",
          "shopify_line_item_id": 11106133639222,
          "shopify_product_id": 11179841648222,
          "shopify_variant_id": 11191300929074,
          "platform": "shopify",
          "files": [
            {
              "id": "01jb3092vabc7m8qw4cdqv09we",
              "name": "default",
              "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png"
            }
          ]
        }
  ]
}]

Error Responses:

Code	Message	Description
401	Unauthorized	Invalid or missing token
403	Unauthorized	You do not have permission to view order

2. Get specific order

Endpoint:

GET /orders/{id}

Description:

Fetch specific order

Path Parameters:

Parameter	Type	Required	Description
`shop`	string	✅	Shopify store name. If your store url is abcdef.myshopify.com, then shop=abcdef
`id`	integer	✅	Shopify store order id

Headers:

Header	Value
`Authorization`	Bearer API_KEY
`Content-Type`	application/json

Request Body:

{
  "shop": "abcdef.myshopify.com",
  "id": 123456789
}

Response:

{
  "shop": "abcdef.myshopify.com",
  "order_id": 123456789,
  "order_number": "123",
  "currency": "USD",
  "customer": "John Doe",
  "email": "john@example.com",
  "ip": "123.123.123.123",
  "total_price": 123.45,
  "financial_status": "paid",
  "fulfillment_status": "fulfilled",
  "ordered_at": "2025-01-21 01:01:01",
  "customizations": [
        {
          "id": "01jjavmg7t7vqj5z6qvxwie14b",
          "campaign_id": "01jphjdfmtxhaio94h0wd0kv0c",
          "shopify_line_item_id": 11106133639222,
          "shopify_product_id": 11179841648222,
          "shopify_variant_id": 11191300929074,
          "platform": "shopify",
          "files": [
            {
              "id": "01jb3092vabc7m8qw4cdqv09we",
              "name": "default",
              "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png"
            }
          ]
        }
  ]
}

Error Responses:

Code	Message	Description
401	Unauthorized	Invalid or missing token
403	Unauthorized	You do not have permission to view this order
404	Not Found	Order does not exist

3. Get specific order's customization

Endpoint:

GET /orders/{order_id}/customizations/{id}

Description:

Retrieve specific customization

Path Parameters:

Parameter	Type	Required	Description
`shop`	string	✅	Shopify store name. If your store url is abcdef.myshopify.com, then shop=abcdef
`store_id`	integer	✅	Shopify store order id
`id`	string	✅	Customization id

Headers:

Header	Value
`Authorization`	Bearer API_KEY
`Content-Type`	application/json

Request Body:

{
  "shop": "abcdef.myshopify.com",
  "order_id": 123456789,
  "id": "01jjavmg7t7vqj5z6qvxwie14b"
}

Response:

{
  "id": "01jjavmg7t7vqj5z6qvxwie14b",
  "campaign_id": "01jphjdfmtxhaio94h0wd0kv0c",
  "shopify_line_item_id": 11106133639222,
  "shopify_product_id": 11179841648222,
  "shopify_variant_id": 11191300929074,
  "platform": "shopify",
  "files": [
    {
      "id": "01jb3092vabc7m8qw4cdqv09we",
      "name": "default",
      "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png"
    }
  ]
}

Error Responses:

Code	Message	Description
401	Unauthorized	Invalid or missing token
403	Unauthorized	You do not have permission to view order
404	Not Found	Customization does not exist

⚠️ Common Error Codes

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

📌 Notes

All responses are in JSON.
Rate limit: 2 requests/second.
Contact admin@customix.io for questions.

Updated on: 20/08/2025

Was this article helpful?

Thank you!