omnicado-mall-proxy
GET /orders/{orderStatus}

Replaced by filters on /orders endpoint.

Returns list of all orders with certain status (replace open with desired status name).

Headers

  • X-Application-Name string

Path parameters

  • orderStatus string Required

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

Query parameters

  • filter string

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

    Value is basic.

  • client_id string Required

    Client identifier

Responses

  • 200

    Order list OK response

    One of:
    object-1 object object-2 object
GET /orders/{orderStatus} 
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/orders/open?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
  }
}
GET /orders/{orderId}

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
    • data array[object]
      Hide data attributes Show data attributes array[object]
      • external_order_id number

        External ID of order if available (internal ID of partner order)

      • currency string Required

        ISO currency code

      • delivery_price number Required

        Price for delivery

      • cod_price number Required

        Price of COD

      • discount number

        Discount of order if available

      • delivery_method string Required

        External ID of used delivery method (defined by partner)

      • delivery_method_id number Required

        Internal ID of used delivery method (ID of pickup point in case of 'Uloženka')

      • branch_id number

        ID of pickup point

      • branches object
        Hide branches attributes Show branches attributes object
        • branch_id integer

          ID of main pickup point

        • secondary_branch_id integer

          ID of secondary pickup point

        • overridden boolean

          if the main branch has been overridden

        • last_change string

          date of the last change made to secondary_branch_id

      • tracking_number string

        Package tracking number. Partners can send it when changing the order status to shipped.

      • ready_to_return boolean

        If true, MDP order is ready to return

      • address object Required

        Customer shipping address

        Hide address attributes Show address attributes object
        • customer_id number Required

          Mall customer ID

        • name string Required

          Full name

        • company string

          Company name

        • phone string Required

          Phone

        • email string Required

          E-mail address

        • street string Required

          Street and house number

        • city string Required

          City

        • zip string Required

          ZIP

        • country string Required

          Country code

      • items array[object] Required

        Items of order

        Hide items attributes Show items attributes array[object]
        • id string Required

          ID of product/variant

        • article_id integer Required

          ID of MALL article

        • title string Required

          Partner article title

        • quantity integer Required

          Number of items

        • price number Required

          Price of item with VAT

        • purchase_price number

          Purchase price if available

        • vat integer Required

          VAT rate in percents

        • commission number

          Value of order item commission

        • serial_numbers array[string]

          Serial numbers

      • ulozenka_status_history array[object]

        Tracking history of MDP Classic orders in Ulozenka

        Hide ulozenka_status_history attributes Show ulozenka_status_history attributes array[object]
        • id integer Required

          ID of the status

        • name string Required

          Name of the status

        • date string Required

          Date when the consignment acquired the status

      • consignment_status_history array[object]

        Tracking history of MDP Spectrum orders

        Hide consignment_status_history attributes Show consignment_status_history attributes array[object]
        • code string Required

          Code of the status

          Values are CREATED, RECEIVED, CANCELLED, DELIVERING, DAMAGED, RETURNING, RETURNED, READY_FOR_PICKUP, DELIVERED, or LOST.

        • date string Required

          Date when the consignment acquired the status

        • flags array[string]

          Values are damaged or lost.

        • tracking_number string

          Tracking number for package

      • 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
GET /orders/{orderId} 
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/orders/{orderId}?client_id=api_token_value
Response examples (200) 
{
  "result": {
    "code": 200,
    "status": "OK"
  },
  "data": [
    {
      "external_order_id": 75,
      "currency": "CZK",
      "delivery_price": 29,
      "cod_price": 42.0,
      "discount": 185,
      "delivery_method": "pplCz",
      "delivery_method_id": 21,
      "branch_id": 21,
      "branches": {
        "branch_id": 29,
        "secondary_branch_id": 21,
        "overridden": true,
        "last_change": "2017-01-27 00:00:00"
      },
      "tracking_number": "abc123",
      "ready_to_return": false,
      "address": {
        "customer_id": 1111111111,
        "name": "string",
        "company": "Company J. D.",
        "phone": 420296245025,
        "email": "john@doe.tld",
        "street": "U Garáží 1611/1",
        "city": "Praha 7",
        "zip": "17000",
        "country": "CZ"
      },
      "items": [
        {
          "id": "F192621",
          "article_id": 100000249018,
          "title": "Partner article title",
          "quantity": 2,
          "price": 350.0,
          "purchase_price": 300.0,
          "vat": 21,
          "commission": 16.0,
          "serial_numbers": [
            "DR0289710229X",
            "DR1388350346A"
          ]
        }
      ],
      "ulozenka_status_history": [
        {
          "id": 4,
          "name": "připraveno k výdeji",
          "date": "28.05.2020 13:54:50"
        }
      ],
      "consignment_status_history": [
        {
          "code": "CREATED",
          "date": "28.05.2020 13:54:50",
          "flags": [
            "damaged"
          ],
          "tracking_number": "00013832"
        }
      ],
      "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"
    }
  ]
}
Response examples (200) 
{
  "result": {
    "code": 200,
    "status": "OK"
  },
  "data": [
    {
      "external_order_id": 75,
      "currency": "CZK",
      "delivery_price": 29,
      "cod_price": 42.0,
      "discount": 185,
      "delivery_method": "pplCz",
      "delivery_method_id": 21,
      "branch_id": 21,
      "branches": {
        "branch_id": 29,
        "secondary_branch_id": 21,
        "overridden": true,
        "last_change": "2017-01-27 00:00:00"
      },
      "tracking_number": "abc123",
      "ready_to_return": false,
      "address": {
        "customer_id": 1111111111,
        "name": "string",
        "company": "Company J. D.",
        "phone": 420296245025,
        "email": "john@doe.tld",
        "street": "U Garáží 1611/1",
        "city": "Praha 7",
        "zip": "17000",
        "country": "CZ"
      },
      "items": [
        {
          "id": "F192621",
          "article_id": 100000249018,
          "title": "Partner article title",
          "quantity": 2,
          "price": 350.0,
          "purchase_price": 300.0,
          "vat": 21,
          "commission": 16.0,
          "serial_numbers": [
            "DR0289710229X",
            "DR1388350346A"
          ]
        }
      ],
      "ulozenka_status_history": [
        {
          "id": 4,
          "name": "připraveno k výdeji",
          "date": "28.05.2020 13:54:50"
        }
      ],
      "consignment_status_history": [
        {
          "code": "CREATED",
          "date": "28.05.2020 13:54:50",
          "flags": [
            "damaged"
          ],
          "tracking_number": "00013832"
        }
      ],
      "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"
    }
  ]
}