UnloadOrders List

Filterable Attributes

Attribute Name	Meaning
customer_id	Id of customer associated with the unload order
state	Current state of the unload order: `draft`, `open`, `pending`, `incomplete,` completed`.
voucher_category	Category of vouchers handled by the unload order

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": 0,
    "current_page": 0,
    "page_size": 0,
    "total_entries": 0
  },
  "data": [
    {
      "id": "sting",
      "completed_at": null,
      "created_at": "2022-06-29T10:49:11.438+02:00",
      "customer": {
        "id": "sting",
        "type": "customer"
      },
      "description": "sting",
      "entries_count": 1,
      "invoice": null,
      "state": "incomplete",
      "submitted_at": "2022-06-29T16:08:15.449+02:00",
      "total_fee": null,
      "total_unloaded": null,
      "total": null,
      "updated_at": "2024-11-05T06:22:23.582+01:00",
      "voucher_category": "benefit_in_kind"
    }
  ],
  "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?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 ********************

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 List#

Filterable Attributes#

Accessible By#

Parameters:#

Return#

Request

Responses

UnloadOrders List

Filterable Attributes

Accessible By

Parameters:

Return