Card Orders List

Filterable Attributes

Attribute Name	Meaning
customer_id	Id of customer of the card order
state	Current state of the card order: `draft`, `open`, `pending`, `processing`, `ordered`, or `completed`

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": "string",
      "state": "ordered",
      "created_at": "2017-05-11T10:26:18.926+02:00",
      "updated_at": "2024-11-05T06:40:46.335+01:00",
      "submitted_at": null,
      "production_started_at": null,
      "delivered_at": null,
      "voucher_category": "unlimited",
      "is_cancellable": false,
      "customer": {
        "type": "customer",
        "id": "string"
      },
      "description": null,
      "invoice": null,
      "production_invoice": {
        "id": "string",
        "number": "12345",
        "creditor": "string",
        "type": "invoice"
      },
      "shipping_invoice": {
        "id": "string",
        "number": "12346",
        "creditor": "string",
        "type": "invoice"
      },
      "entries_count": 1
    }
  ],
  "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/card_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

boolean

optional

page[number]

integer

optional

Example:

page[size]

integer

optional

Example:

Header Params

Authorization

string

required

Example:

Bearer {{token}}

Accept-Version

string

required

Example:

List

Card Orders List#

Filterable Attributes#

Accessible By#

Parameters:#

Return#

Request

Responses

Card Orders List

Filterable Attributes

Accessible By

Parameters:

Return