Equotix One API
  1. Promotion
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
          POST
        • extension/total/promotion/getCategory
          POST
        • extension/total/promotion/getHistory
          POST
      • 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
      • sale/order/edit
      • sale/order/delete
      • sale/order/get
      • sale/order/getHistory
      • sale/order/addHistory
  • 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. Promotion

extension/total/promotion/get

POST
/extension/total/promotion/get
This returns the list of promotions available for 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.
filter_name
string 
optional
Filters the list by the name.
filter_title
string 
optional
Filters the list by the title.
filter_type
string 
optional
Filters the list by the promotion type.
filter_status
integer 
optional
Filters the list by the status.
filter_date_modified
string 
optional
Filter the list of promotions modified after the spcified date.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "name", "type", "status", "total_used", "date_start", "date_end", "date_added", "date_modified", "sort_order".
order
string 
optional
The direction for the ordering of the results. Accepts "ASC", "DESC"
limit
integer 
optional
The number of results per page. Accepts 1 to 100.
Example
{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "filter_name": "string",
  "filter_title": "string",
  "filter_type": "string",
  "filter_status": 0,
  "filter_date_modified": "string",
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success
application/json
Body
error
array[string]
optional
Returns only if there is an error.
total
integer 
optional
The total number of results available if there is no error.
promotions
array [object {16}] 
optional
The list of promotions available if there is no error.
promotion_id
integer 
required
The promotion ID.
name
string 
required
The name.
title
string 
required
The title.
total_promotion
boolean 
required
Indicates if it is a order total promotion.
type
string 
required
The promotion type.
status
boolean 
required
The status.
sort_order
integer 
required
The sort order.
configuration
object 
required
The promotion settings key-value.
total
number 
required
The promotion minimum total amount.
total_use_limit
integer 
required
The promotion use limit count.
total_used
integer 
required
The promotion total used count.
date_start
string 
required
The date time promotion starts.
date_end
string 
required
The date time promotion ends.
date_added
string 
required
The date time promotion was created.
date_modified
string 
required
The date time the promotion was last modified.
categories
object 
required
The promotion linked categories.
Example
{
  "error": [
    "string"
  ],
  "total": 0,
  "promotions": [
    {
      "promotion_id": 0,
      "name": "string",
      "title": "string",
      "total_promotion": true,
      "type": "string",
      "status": true,
      "sort_order": 0,
      "configuration": {},
      "total": 0,
      "total_use_limit": 0,
      "total_used": 0,
      "date_start": "string",
      "date_end": "string",
      "date_added": "string",
      "date_modified": "string",
      "categories": {}
    }
  ]
}
Previous
extension/report/channel_payout/get
Next
extension/total/promotion/getCategory
Built with