Get list of unconfirmed orders

GET /orders/unconfirmed

Orders are set to unconfirmed = true when:

order is created in status blocked
order is paid and set in status open by MALL (cash on delivery and test orders always start in open status)
MALL updates order detail
MALL or customer cancels the order and status is set to cancelled
MALL updates order status as part of MALL Delivery service

We recommend regular check of unconfirmed orders to be able to promptly deliver the order to the customer. Recommended interval is once an hour.

⚠ Attention

Our system also provides webhooks to easily track order updates from MALL, without the need of regular checks. Please check more information here.

Headers

X-Application-Name string

Query parameters

client_id string Required

Client identifier
filter string

With URL parameter filter=basic objects with basic data are returned instead of list of ids.

Value is basic.

Responses

200

Order list OK response
One of:
object-1 object object-2 object
List of order ids

Hide attributes Show attributes

data array[integer]

result object

Hide result attributes Show result attributes object

code integer(int)

status string

paging object

Hide paging attributes Show paging attributes object

pages integer

size integer

page integer
List of basic order objects

Hide attributes Show attributes

data array[object]

Hide data attributes Show data attributes array[object]

customer_id number Required

Mall customer ID

customer string Required

Name and surname of the customer

id integer Required

Order ID

source string | null Required

Order Source

external_id string | null Required

External ID

purchase_id integer Required

MALL internal purchase ID

cod number Required

Price of COD (cash on delivery), double

ship_date string Required

Expected date of shipment

delivered_at string

Date when order has been delivered to customer

status string Required

Description of statuses:

blocked - order is blocked and cannot be processed by partner yet

open - order is open (paid successfully or uses cash on delivery) and ready for shipment by partner

shipping - order is in shipment process

shipped - order is being shipped to the customer and cannot be cancelled

delivered - final status, order was delivered to the customer

returned - final status, order was returned as undelivered and is not invoiced

cancelled - final status, order was cancelled and is not invoiced

lost - final status, order was lost during delivery (only for orders shipped with MDP, status is managed by MALL)

Values are blocked, open, shipping, shipped, delivered, returned, cancelled, or lost.

confirmed boolean Required

Information if the order is confirmed by partner or not

test boolean

True means the order is only testing, false means production orders

mdp boolean

Whether order uses MDP (Mall delivery platform), either Classic or Spectrum

mdp_classic boolean

Whether order uses MDP (Mall delivery platform) Classic

mdp_spectrum boolean

Whether order uses MDP (Mall delivery platform) Spectrum

shipped string

last date of change order to status shipped

shipping string

last date of change order to status shipping

open string

last date of change order to status open

blocked string

last date of change order to status blocked

lost string

last date of change order to status lost

returned string

last date of change order to status returned

cancelled string

last date of change order to status cancelled

delivered string

last date of change order to status delivered

result object

Hide result attributes Show result attributes object

code integer(int)

status string

paging object

Hide paging attributes Show paging attributes object

pages integer

size integer

page integer

GET /orders/unconfirmed

curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/orders/unconfirmed?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"

Response examples (200)

{
  "data": [
    569847,
    569891,
    569936
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}

{
  "data": [
    {
      "customer_id": 1111111111,
      "customer": "John Doe",
      "id": 89591350,
      "source": "mallCz",
      "external_id": "24bcb8fe-13d8-11ed-861d-0242ac120002",
      "purchase_id": 89591351,
      "cod": 25.0,
      "ship_date": "2017-01-14",
      "delivered_at": "2018-01-14 08:13:00",
      "status": "open",
      "confirmed": true,
      "test": false,
      "mdp": false,
      "mdp_classic": false,
      "mdp_spectrum": false,
      "shipped": "2019-07-02 10:19:14",
      "shipping": "2019-07-02 10:19:14",
      "open": "2019-07-02 10:19:14",
      "blocked": "2019-07-02 10:19:14",
      "lost": "2019-07-02 10:19:14",
      "returned": "2019-07-02 10:19:14",
      "cancelled": "2019-07-02 10:19:14",
      "delivered": "2019-07-02 10:19:14"
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}

Response examples (200)

{
  "data": [
    569847,
    569891,
    569936
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}

{
  "data": [
    {
      "customer_id": 1111111111,
      "customer": "John Doe",
      "id": 89591350,
      "source": "mallCz",
      "external_id": "24bcb8fe-13d8-11ed-861d-0242ac120002",
      "purchase_id": 89591351,
      "cod": 25.0,
      "ship_date": "2017-01-14",
      "delivered_at": "2018-01-14 08:13:00",
      "status": "open",
      "confirmed": true,
      "test": false,
      "mdp": false,
      "mdp_classic": false,
      "mdp_spectrum": false,
      "shipped": "2019-07-02 10:19:14",
      "shipping": "2019-07-02 10:19:14",
      "open": "2019-07-02 10:19:14",
      "blocked": "2019-07-02 10:19:14",
      "lost": "2019-07-02 10:19:14",
      "returned": "2019-07-02 10:19:14",
      "cancelled": "2019-07-02 10:19:14",
      "delivered": "2019-07-02 10:19:14"
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}