Listare comenzi - celdotro/marketplace GitHub Wiki

Despre

  • Permite listarea comenzilor care indeplinesc anumite criterii

Clasa

celmarket\Orders\OrdersList

Metoda

listOrders

API

  • metoda: orders
  • actiune: listOrders

Parametri

  • start = pozitia de pornire a listei de comenzi returnate
  • limit = numarul maxim de comenzi returnate
  • filters = filtrele aplicate listarii -> array
    • minDate = data de inceput
    • maxDate = data de sfarsit
    • customer = parte componenta a numelui / nume partial
    • customerSign = semn de comparare cu numele
      • ee = egal
      • ne = diferit
    • product = parte componenta a numelui / nume partial
    • productSign = semn de comparare cu numele
      • ee = egal
      • ne = diferit
    • order = numarul comenzii
      • null, 0 sau sirul vid duc la neaplicarea filtrului
    • invoice = numarul facturii
      • null, 0 sau sirul vid duc la neaplicarea filtrului
    • order_status = starea comenzii
      • null, 0, 99 sau sirul vid duc la neaplicarea filtrului
    • group_by_status = true sau nesetat, daca se doreste gruparea in functie de status (implicit), false, altfel
    • order_by_date_purchased = nesetat, va folosi ordonare in functie de orders_id, DESC, ordonare descrescatoare in functie de date_purchased, ASC ordonare crescatoare in functie de date_purchased
    • min_order = nesetat sau 0, nu va pune un minim comenzii si va sorta descrescator in functie de orders_id, altfel va impune un id minim de comanda si va sorta crescator in functie de orders_id
    • last_changed = ultima schimbare -> array
      • minDate = data minima
      • maxDate = data maxima
    • phoneNumber = numarul de telefon al clientului

Raspuns

Un obiect cu urmatoarele atribute

  • (atribut) = informatii despre comenzile cu un anumit status
    • (denumirea atributului) = numarul statusului
    • (valoarea atributului) = obiect cu urmatoarele atribute
      • limit = numarul maxim de comenzi returnate
      • start = pozitia de inceput a listarii
      • moreavailable = 1 -> mai sunt comenzi nelistate, 0 -> nu mai sunt comenzi nelistate
      • list = lista cu comenzi -> array
        • (element din array) = comanda care indeplineste conditiile din filtru -> obiect
          • customer_company = numele persoanei juridice / fizice a clientului
          • data = data comenzii
          • ora = ora comenzii
          • mod_plata = modul de plata
          • status = statusul comenzii
          • valoarecomanda = valoarea comenzii
          • mod_livrare = modul de livrare
          • orders_id = id-ul comenzii
          • id_adresa_afiliat = ID-ul adresei de ridicare a comenzii de catre curier
          • source = site-ul de origine al comenzii

Exemplu - PHP

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

Exemplu - 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
  }
}
⚠️ **GitHub.com Fallback** ⚠️