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
domain
string 
required
The domain you are assigned to authenticate your Equotix One account.
api_key
string 
required
The email address assigned to the user account in your Equotix One.
auth_timestamp
integer 
required
The unix timestamp used to sign this API request.
auth_signature
string 
required
The calculated signature for this API request.
imported_order_id
string 
required
The ID to be used from external channel.
channel_id
integer 
required
The channel ID to associate this order to. Only supports an Equotix POS channel ID.
customer_id
integer 
required
The order customer ID. Use "0" to create a new customer.
firstname
string 
required
The order first name.
lastname
string 
required
The order last name.
company
string 
required
The order company.
email
string 
required
The order email.
telephone
string 
required
The order telephone.
telephone_2
string 
required
The order telephone 2.
date_ordered
string 
required
The date time order placed.
address_1
string 
required
The order address 1.
address_2
string 
required
The order address 2.
city
string 
required
The order city.
postcode
string 
required
The order postcode.
country
string 
required
The order country.
zone
string 
required
The order zone.
shipping_method
string 
required
The order shipping method.
shipping_date
string 
required
The date time order shipped out.
shipping_tracking
string 
required
The order shipping tracking code.
currency
string 
required
The order currency code. Must be already added into the account.
currency_value
number 
required
The order currency value. Enter 0 for auto value.
payment_method
integer 
required
The order payment method ID.
total
number 
required
The order total amount.
comment
string 
required
The order comment.
products
array [object {10}] 
required
The items in the order.
item_id
integer 
required
The item ID. 0 is accepted.
name
string 
required
The item name.
model
string 
required
The item model code. If 0 is used for the item ID, the model code will be matched to search for the correct item ID.
sku
string 
required
The item sku code.
quantity
integer 
required
The item quantity.
price
number 
required
The item price.
cost
number 
optional
The item cost if API has view permission.
discount
number 
required
The item discount amount per quantity.
discount_total
number 
required
The item discount amount for the whole line, on top of the discount per unit.
totals
array [object {4}] 
optional
The item line total charges or discounts.
totals
array [object {4}] 
required
The order line total charges or discounts.
name
string 
required
The name for the order line total.
code
string 
required
The unique code for the order line total.
price
number 
required
The price for the order line total.
sort_order
integer 
required
The sort order for the order line total to be displayed.
split_payment
integer 
required
Indicates whether there's multiple payment methods with "1" or "0".
payments
array [object {2}] 
optional
The list of payment methods if split payment is "1".
payment_method
string 
required
The payment method name.
total
number 
required
The payment method amount.
order_status_id
integer 
required
Set the default order status ID.
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
error
array[string]
optional
Returns only if there is an error.
success
boolean 
optional
Returns only if there is no error.
order
object 
optional
The order added.
order_id
integer 
required
The order ID.
imported_order_id
string 
required
The channel order ID.
location_id
integer 
required
The location ID.
channel_id
integer 
required
The channel ID.
channel
string 
required
The channel name.
payment_method
string 
required
The payment method.
customer_id
integer 
required
The customer ID.
firstname
string 
required
The order first name.
lastname
string 
required
The order last name.
email
string 
required
The order email.
name
string 
required
The order first name and last name merged.
company
string 
required
The order company.
telephone
string 
required
The order telephone.
telephone_2
string 
required
The order telephone 2.
address_1
string 
required
The order address 1.
address_2
string 
required
The order address 2.
city
string 
required
The order city.
postcode
string 
required
The order postcode.
country
string 
required
The order country.
zone
string 
required
The order zone.
order_status
string 
required
The order status.
order_status_id
integer 
required
The order status ID.
shipping_label_status_id
integer 
required
The order shipping label status ID.
order_blacklist_id
integer 
required
The order blacklist ID.
currency
string 
required
The order currency code.
currency_value
number 
required
The order currency value.
total
number 
required
The order total.
cost
number 
optional
The order cost if user has view permission.
shipping_method
string 
required
The order shipping method.
shipping_tracking
string 
required
The order shipping tracking.
shipping_date
string 
required
The order date time shipped.
date_ordered
string 
required
The order date time placed.
date_added
string 
required
The order date time added.
date_modified
string 
required
The order date time last modified.
comment
string 
required
The order comment.
locked
boolean 
required
Indicates if the order is locked from editing.
weight
number 
required
The order total weight.
products
array [object {17}] 
required
The order products.
payments
array [object {2}] 
required
totals
array [object {4}] 
required
The order line totals.
payouts
array [object {2}] 
required
The order payout data from its channel.
data
array [object {2}] 
required
Additional order data stored.
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