Retrieve order groups

Retrieve order groups

#b2b

https://api.worldota.net/api/b2b/v3/ordergroup/info/

The call gets the order group information. Use it to check the order group information before applying the Make order group overpay call.

Request example

curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/b2b/v3/ordergroup/info/' \
--header 'Content-Type: application/json' \
--data '{
  "ordering": {
    "ordering_type": "asc",
    "ordering_by": "invoice_id"
  },
  "pagination": {
    "page_size": "1",
    "page_number": "1"
  },
  "search": {
    "invoice_id": "12980-00260"
  }
}'

Request body

Response

Response example

{
  "data":{
    "current_page_number":1,
    "groups":[
      {
        "agreement_number":"B2B-12980/1",
        "amount_commission": {
          "amount":"0.73",
          "currency_code":"EUR"
        },
        "amount_commission_vat":{
          "amount":"0",
          "currency_code":"EUR"
        },
        "amount_payable":{
          "amount":"7.27",
          "currency_code":"EUR"
        },
        "amount_payable_vat":{
          "amount":"0",
          "currency_code":"EUR"
        },
        "created_at":"2018-12-04T08:51:10.254781",
        "invoice_id":"12980-00260",
        "orders":[
          {
            "amount_commission":{
              "amount":"0.73",
              "currency_code":"EUR"
            },
            "amount_commission_vat":{
              "amount":"0",
              "currency_code":"EUR"
            },
            "amount_payable":{
              "amount":"7.27",
              "currency_code":"EUR"
            },
            "amount_payable_vat":{
              "amount":"0",
              "currency_code":"EUR"
            },
            "created_at":"2018-12-04T08:49:36.129298",
            "order_id":863255831,
            "order_type":"hotel",
            "payment_due":"2018-12-14",
            "status":"completed"
          }
        ],
        "payment_due":"2018-12-14"
      }
    ],
    "total_groups":1,
    "total_pages":1
  },
  "debug":null,
  "error":null,
  "status":"ok"
}

Errors

The error field has the value specified in the headers below.

page_out_of_range

The current_page_number field value is greater than the total_pages field value. It should be less.