Order Details

The “Order details” endpoint shows the details of one order so the ROBIN Agent can see more information of one particular order from the customer. Once a ROBIN Agent clicks on order shown in the “Order list” from Endpoint 2, Endpoint 3 will be called by the parameter “ID” filled with the order_number in the object of “orders” from Endpoint 2 “Order list”.

GET https://example.com/orders?<yourOrderNumber>=$Id

Parameters

Name	Required	Description
$Id	Yes	The order_number of the clicked object of “orders” from Endpoint 2 “Order list”

Response body

{
  "details_view": [
    {
      "display_as": "details",
      "data": {
        "date": "29-01-2021 12:34",
        "status": "In progress",
        "payment_status": "Partially paid",
        "shipment_status": "Partially shipped",
        "": "<div class=\'panel_button\'><div><a href=\'http://yourwebsite.com\' target=\'_blank\'>Edit order</a></div></div>"
      }
    },
    {
      "display_as": "columns",
      "caption": "products",
      "data": [
        {
          "product": "Phone",
          "quantity": "1",
          "price": "$695.50"
        },
        {
          "product": "Tablet",
          "quantity": "2",
          "price": "$898.00"
        },
        {
          "product": "Shipment",
          "quantity": "",
          "price": "$10.00"
        },
        {
          "product": "Total",
          "quantity": "",
          "price": "$1603.50"
        }
      ]
    },
    {
      "display_as": "rows",
      "caption": "invoices",
      "data": [
        {
          "shipment": "<a href='http://shop.example.com/invoice/CMI01'>CMI01</a>",
          "status": "Paid",
          "amount": "$1200.00"
        },
        {
          "shipment": "<a href='http://shop.example.com/invoice/CMI02'>CMI02</a>",
          "status": "Not paid",
          "amount": "$403.50"
        }
      ]
    }
  ]
}

Response schema

Name	Type	Required	Description
display_as	String	Yes	The layout the information in showed in the panel (details, row and columns)
caption	Object	Yes	The caption in the details from the order
data	Object	Yes	This is the object where all the information is stored