{
  "opencollection": "1.0.0",
  "info": {
    "name": "Canix Sales Orders API",
    "version": "1.3.10"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-KEY",
      "value": "{{X-API-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Sales Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetSalesOrders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/sales_orders",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Max number of records to return (optional). Cannot exceed 2000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for the returned records (optional)"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Order-by clause, in SQL format (optional)"
              },
              {
                "name": "where",
                "value": "",
                "type": "query",
                "description": "Filter results using SQL-like WHERE clause syntax (optional).\n\n**Supported operators**: =, >, <, >=, <=, BETWEEN, IN, LIKE, AND, OR\n\n**Supported patterns**:\n- Equality: `status='Active'`\n- Comparison: `updated_at >= '2024-01-01'`\n- Range: `id BETWEEN 1 AND 10000`\n- List: `status IN ('Active', 'Pending')`\n- Pattern: `sku LIKE 'ABC%'`\n- Compound: `facility_id=123 AND is_active=true`\n"
              }
            ]
          },
          "docs": "Return Sales Orders"
        },
        {
          "info": {
            "name": "CreateSalesOrder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.canix.com/api/v1/sales_orders",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__CALLING THIS ENDPOINT WILL MODIFY YOUR DATA IRREVERSIBLY. ONLY CALL THIS ON SANDBOX DATA DURING DEVELOPMENT/CODING/TESTING.__"
        },
        {
          "info": {
            "name": "GetSalesOrder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/sales_orders/:sales_order_id",
            "params": [
              {
                "name": "sales_order_id",
                "value": "",
                "type": "path",
                "description": "ID of Sales Order to return"
              }
            ]
          },
          "docs": "Get Sales Order by ID"
        },
        {
          "info": {
            "name": "UpdateSalesOrder",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.canix.com/api/v1/sales_orders/:sales_order_id",
            "params": [
              {
                "name": "sales_order_id",
                "value": "",
                "type": "path",
                "description": "ID of Sales Order to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__CALLING THIS ENDPOINT WILL MODIFY YOUR DATA IRREVERSIBLY. ONLY CALL THIS ON SANDBOX DATA DURING DEVELOPMENT/CODING/TESTING.__"
        },
        {
          "info": {
            "name": "GetSalesOrderContents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/sales_orders/:sales_order_id/contents",
            "params": [
              {
                "name": "sales_order_id",
                "value": "",
                "type": "path",
                "description": "Sales Order ID"
              }
            ]
          },
          "docs": "Get Sales Order Contents by Sales Order ID"
        },
        {
          "info": {
            "name": "GetSalesOrderPayments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/sales_orders/:sales_order_id/payments",
            "params": [
              {
                "name": "sales_order_id",
                "value": "",
                "type": "path",
                "description": "Sales Order ID"
              }
            ]
          },
          "docs": "Get Sales Order Payments by Sales Order ID"
        },
        {
          "info": {
            "name": "UpdateSalesOrderStatus",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.canix.com/api/v1/sales_orders/:sales_order_id/status/:status_name",
            "params": [
              {
                "name": "sales_order_id",
                "value": "",
                "type": "path",
                "description": "ID of Sales Order to update status"
              },
              {
                "name": "status_name",
                "value": "",
                "type": "path",
                "description": "New status for the Sales Order (created, approved, filled, shipped, accepted, archived, requested, canceled)"
              }
            ]
          },
          "docs": "Update the status of a Sales Order.\nValid status values: created, approved, filled, shipped, accepted, archived, requested, canceled\nTo cancel a sales order, use status_name = \"canceled\"\nNote: Cannot cancel orders that are shipped, accepted, returned, or archived.\n__CALLING THIS ENDPOINT WILL MODIFY YOUR DATA IRREVERSIBLY. ONLY CALL THIS ON SANDBOX DATA DURING DEVELOPMENT/CODING/TESTING.__\n"
        },
        {
          "info": {
            "name": "GetPayments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/payments",
            "params": [
              {
                "name": "facility_id",
                "value": "123",
                "type": "query",
                "description": "Facility ID (optional)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Max number of records to return (optional). Cannot exceed 2000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for the returned records (optional)"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Order-by clause, in SQL format (optional)"
              },
              {
                "name": "where",
                "value": "",
                "type": "query",
                "description": "Filter results using SQL-like WHERE clause syntax (optional).\n\n**Supported operators**: =, >, <, >=, <=, BETWEEN, IN, LIKE, AND, OR\n\n**Supported patterns**:\n- Equality: `status='Active'`\n- Comparison: `updated_at >= '2024-01-01'`\n- Range: `id BETWEEN 1 AND 10000`\n- List: `status IN ('Active', 'Pending')`\n- Pattern: `sku LIKE 'ABC%'`\n- Compound: `facility_id=123 AND is_active=true`\n"
              }
            ]
          },
          "docs": "Return sales order payments across all of the company's facilities, newest first.\nFilter by received date with the `where` parameter, e.g. `where=payment_date >= '2026-01-01'`.\n"
        },
        {
          "info": {
            "name": "GetPayment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canix.com/api/v1/payments/:payment_id",
            "params": [
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "Payment ID"
              }
            ]
          },
          "docs": "Get a sales order payment by ID"
        }
      ]
    }
  ],
  "bundled": true
}