List orders

About

• Lists commands that fit the filters

Class

celmarket\Orders\OrdersList

Method

listOrders

API

• method: orders
• action: listOrders

Parameters

• start = start position for the list
• limit = maximum number of returned values
• filters = list filters -> array
  • minDate = starting date
  • maxDate = end date
  • customer = partial name
  • customerSign = comparison sign
    • ee = equal
    • ne = not equal
  • product = partial name
  • productSign = comparison sign
    • ee = equal
    • ne = not equal
  • order = order's id
    • null, 0 or empty string will render the filter not applicable
  • invoice = invoice's number
    • null, 0 or empty string will render the filter not applicable
  • order_status = order's status
    • null, 0, 99 or empty string will render the filter not applicable
  • group_by_status = true or not set for the orders to be grouped by status (implicitly), false, otherwise
  • order_by_date_purchased = if it's not set, it will sort by orders_id, if it's set to ASC it will sort ascending by date_purchased and if it's set to DESC it will sort descending by date_purchased
  • min_order = if it's unset or 0, it will not enforce a minimum value for the order and will sort descending by orders_id, otherwise it will impose a minimum limit on orders_id and sort the results ascending by orders_id
  • last_changed = last change
    • minDate = minimum date
    • maxDate = maximum date
  • phoneNumber = client's phone number

Response

An object with the following attributes

• (attribute) = object containing information about orders with a specific status
  • (attribute's name) = status
  • (attribute's value) = an object with the following attributes
    • limit = maximum number of returned campaigns
    • start = start position
    • moreavailable = 1 -> there are more orders that haven't been returned, 0 -> there are no more orders to be returned
    • list = orders list -> array
      • (array element) = an order that fits the filter conditions -> object
        • customer_company = company / personal name of the client
        • data = order date
        • ora = order hour
        • mod_plata = payment method
        • status = order's status
        • valoarecomanda = order's value
        • mod_livrare = delivery method
        • orders_id = order's id
        • id_adresa_afiliat = pick-up address' ID
        • source = order's originating site

Example - PHP

https://github.com/celdotro/marketplace_examples/blob/master/Orders/2.listOrders.php

Example - JSON

{
  "request": {
   "start": 0,
   "limit": 1,
   "arrOptions": {
    "minDate": "01-01-2018",
    "maxDate": "01-01-2018",
    "customer": "X",
    "customerSign": "X",
    "product": "X",
    "productSign": "X",
    "order": 1,
    "invoice": 1,
    "orders_status": 1,
    "group_by_status": true,
    "order_by_date_purchased": "X",
    "min_order": 1,
    "payment_method": "X"
   } 
  },
  
  "response": {
    "moreavailable": "X",
    "limit": 1,
    "start": 0,
    "list": [
      {
        "customers_name": "X",
        "date_purchased": "01-01-2018",
        "payment_method": "X",
        "status_plata": 1,
        "order_total": 1,
        "delivery_company": "X",
        "orders_id": 1,
        "platit": 1,
        "serie": "X",
        "nr_fact": 1,
        "awb": "X",
        "customers_state": "X",
        "status": 1,
        "timestamp": 1
      }
    ],
    "count": 1
  }
}