UnloadOrders - Entries List

Filterable Attributes

None.

Accessible By

multiplier, customer

Parameters:

name	type	default	info
sort	string	NONE	OPTIONAL, defaults to created_at
skip_meta_totals	boolean	false	OPTIONAL, defaults to false
page[number] integer/string	1		OPTIONAL, defaults to 1
page[size]	integer/string	25	OPTIONAL, default page size is 25, max page size is 250

Return

{
  "meta": {
    "total_pages": 1,
    "current_page": 1,
    "page_size": 25,
    "total_entries": 1
  },
  "data": [
    {
      "id": "string",
      "created_at": null,
      "updated_at": null,
      "ordered_at": null,
      "completed_at": null,
      "amount": {
        "cents": 12000,
        "currency": "EUR"
      },
      "minimum_unload_amount": {
        "cents": 1190,
        "currency": "EUR"
      },
      "available_balance": {
        "cents": 2400,
        "currency": "EUR"
      },
      "unloaded_amount": {
        "cents": 1200,
        "currency": "EUR"
      },
      "unload_fee": {
        "cents": 1000,
        "currency": "EUR"
      },
      "state": "open",
      "voucher": {
        "type": "voucher",
        "id": "string",
        "token": "string"
      }
    }
  ],
  "links": {
    "self": "http://example.com",
    "first": "http://example.com",
    "prev": "http://example.com",
    "next": "http://example.com",
    "last": "http://example.com"
  }
}

curl --location -g --request GET 'https://www-staging.givve.com/api/unload_orders//entries?sort=created_at&skip_meta_totals=&page[number]=1&page[size]=25' \ --header 'Authorization: Bearer ' \ --header 'Accept-Version: v2'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

unload_order_id

string

required

Query Params

sort

string

optional

Example:

created_at

skip_meta_totals

string

optional

page[number]

string

optional

Example:

page[size]

string

optional

Example:

Header Params

Authorization

string

required

Example:

Bearer {{token}}

Accept-Version

string

required

Example:

List

UnloadOrders - Entries List#

Filterable Attributes#

Accessible By#

Parameters:#

Return#

Request

Responses

UnloadOrders - Entries List

Filterable Attributes

Accessible By

Parameters:

Return