Equotix One API
  1. Order
Equotix One API
  • Getting Started
    • Introduction
    • Authentication
    • API Example
    • Rate Limits
    • API Terms of Use
  • Extension
    • Dashboard
      • Announcement
        • extension/dashboard/announcement/get
    • Module
      • Invoice Copy
        • extension/module/invoice/get
    • Report
      • Channel Payout
        • extension/report/channel_payout/get
    • Total
      • Promotion
        • extension/total/promotion/get
        • extension/total/promotion/getCategory
        • extension/total/promotion/getHistory
      • Tax
        • extension/module/tax/get
  • Integration
    • Channel
      • integration/channel/get
    • Extension
      • integration/extension/get
    • Profile
      • integration/profile/get
  • Inventory
    • Addition
      • inventory/addition/add
      • inventory/addition/edit
      • inventory/addition/delete
      • inventory/addition/get
    • Brand
      • inventory/brand/add
      • inventory/brand/edit
      • inventory/brand/delete
      • inventory/brand/get
    • Category
      • inventory/category/add
      • inventory/category/edit
      • inventory/category/delete
      • inventory/category/get
    • Deduction
      • inventory/deduction/add
      • inventory/deduction/edit
      • inventory/deduction/delete
      • inventory/deduction/get
    • Flow
      • inventory/flow/get
    • Item
      • inventory/item/add
      • inventory/item/edit
      • inventory/item/delete
      • inventory/item/get
      • inventory/item/editStock
    • Location
      • inventory/location/add
      • inventory/location/edit
      • inventory/location/delete
      • inventory/location/get
    • Purchase Order
      • inventory/purchase_order/add
      • inventory/purchase_order/edit
      • inventory/purchase_order/delete
      • inventory/purchase_order/get
    • Reservation
      • inventory/reservation/add
      • inventory/reservation/edit
      • inventory/reservation/delete
      • inventory/reservation/get
    • Stock Take Job
      • inventory/stock_take_job/get
    • Supplier
      • inventory/supplier/add
      • inventory/supplier/edit
      • inventory/supplier/delete
      • inventory/supplier/get
    • Transfer Job
      • inventory/transfer_job/get
    • Transfer
      • inventory/transfer/add
      • inventory/transfer/edit
      • inventory/transfer/delete
      • inventory/transfer/get
  • Sale
    • Credit Note
      • sale/credit_note/add
      • sale/credit_note/edit
      • sale/credit_note/delete
      • sale/credit_note/get
      • sale/credit_note/getHistory
      • sale/credit_note/addHistory
    • Customer Group
      • sale/customer_group/add
      • sale/customer_group/edit
      • sale/customer_group/delete
      • sale/customer_group/get
    • Customer
      • sale/customer/add
      • sale/customer/edit
      • sale/customer/delete
      • sale/customer/get
      • sale/customer/addReward
      • sale/customer/getReward
    • Order
      • sale/order/add
        POST
      • sale/order/edit
        POST
      • sale/order/delete
        POST
      • sale/order/get
        POST
      • sale/order/getHistory
        POST
      • sale/order/addHistory
        POST
  • Setting
    • Channel Group
      • setting/channel_group/add
      • setting/channel_group/edit
      • setting/channel_group/delete
      • setting/channel_group/get
    • Company
      • setting/company/get
    • Credit Note Status
      • setting/credit_note_status/add
      • setting/credit_note_status/edit
      • setting/credit_note_status/delete
      • setting/credit_note_status/get
    • Currency
      • setting/currency/get
    • Language
      • setting/language/get
    • Order Status
      • setting/order_status/add
      • setting/order_status/edit
      • setting/order_status/delete
      • setting/order_status/get
    • Payment Method
      • setting/payment_method/add
      • setting/payment_method/edit
      • setting/payment_method/delete
      • setting/payment_method/get
    • User Group
      • setting/user_group/get
    • User
      • setting/user/get
  1. Order

sale/order/add

POST
/sale/order/add
This adds an order to the Equotix One account.

Request

Body Params application/json

Example
{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "imported_order_id": "string",
    "channel_id": 0,
    "customer_id": 0,
    "firstname": "string",
    "lastname": "string",
    "company": "string",
    "email": "string",
    "telephone": "string",
    "telephone_2": "string",
    "date_ordered": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "postcode": "string",
    "country": "string",
    "zone": "string",
    "shipping_method": "string",
    "shipping_date": "string",
    "shipping_tracking": "string",
    "currency": "string",
    "currency_value": 0,
    "payment_method": 0,
    "total": 0,
    "comment": "string",
    "products": [
        {
            "item_id": 0,
            "name": "string",
            "model": "string",
            "sku": "string",
            "quantity": 0,
            "price": 0,
            "cost": 0,
            "discount": 0,
            "discount_total": 0,
            "totals": [
                {
                    "name": "string",
                    "code": "string",
                    "price": 0,
                    "sort_order": 0
                }
            ]
        }
    ],
    "totals": [
        {
            "name": "string",
            "code": "string",
            "price": 0,
            "sort_order": 0
        }
    ],
    "split_payment": 0,
    "payments": [
        {
            "payment_method": "string",
            "total": 0
        }
    ],
    "order_status_id": 0
}

Responses

🟢200Success
application/json
Body

Example
{
    "error": [
        "string"
    ],
    "success": true,
    "order": {
        "order_id": 0,
        "imported_order_id": "string",
        "location_id": 0,
        "channel_id": 0,
        "channel": "string",
        "payment_method": "string",
        "customer_id": 0,
        "firstname": "string",
        "lastname": "string",
        "email": "string",
        "name": "string",
        "company": "string",
        "telephone": "string",
        "telephone_2": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "postcode": "string",
        "country": "string",
        "zone": "string",
        "order_status": "string",
        "order_status_id": 0,
        "shipping_label_status_id": 0,
        "order_blacklist_id": 0,
        "currency": "string",
        "currency_value": 0,
        "total": 0,
        "cost": 0,
        "shipping_method": "string",
        "shipping_tracking": "string",
        "shipping_date": "string",
        "date_ordered": "string",
        "date_added": "string",
        "date_modified": "string",
        "comment": "string",
        "locked": true,
        "weight": 0,
        "products": [
            {
                "order_product_id": 0,
                "imported_order_product_id": "string",
                "item_id": 0,
                "thumb": "string",
                "name": "string",
                "model": "string",
                "sku": "string",
                "quantity": 0,
                "price": 0,
                "discount": 0,
                "discount_platform": 0,
                "total": 0,
                "cost": 0,
                "order_status": "string",
                "order_status_id": 0,
                "weight": 0,
                "deducted": true
            }
        ],
        "payments": [
            {
                "payment_method": "string",
                "total": 0
            }
        ],
        "totals": [
            {
                "code": "string",
                "name": "string",
                "price": 0,
                "sort_order": 0
            }
        ],
        "payouts": [
            {
                "name": "string",
                "amount": 0
            }
        ],
        "data": [
            {
                "name": "string",
                "value": "string"
            }
        ]
    }
}
Modified at 2024-11-04 12:48:55
Previous
sale/customer/getReward
Next
sale/order/edit
Built with