Skip to content
digizeDocs

List card orders

GET
/api/v1/cards/orders
curl --request GET \
  --url https://digize.com/api/v1/cards/orders \
  --header 'x-api-key: <x-api-key>'

Orders of NFC review cards and where each is, the newest first.

Needs the reviews:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
number
required
number
placedAt
required
string format: date-time
placedBy
required
string
lines
required
Array<object>
object
design
required
string
Allowed values: printed plain
format
required
string
Allowed values: card stand sticker
quantity
required
number
unitPrice
required

Each, in cents.

number
artwork
required
string | null
logoUrl
required
string | null
shipTo
required
object
name
required
string
<= 120 characters
line1
required
string
<= 120 characters
line2
required
string
<= 120 characters
city
required
string
<= 80 characters
region
required
string
<= 40 characters
postalCode
required
string
<= 20 characters
country
required
string
<= 60 characters
hostname
required

The tap page address its cards’ links are on.

string
status
required
string
Allowed values: in_production shipped delivered cancelled
shippedAt
required
Any of:
string format: date-time
deliveredAt
required
Any of:
string format: date-time
estimatedAt
required
Any of:
string format: date-time
carrier
required
string
Allowed value: USPS
tracking
required
string | null
shipping
required
number
total
required

In cents, with shipping.

number
cardIds
required
Array<string>
charged
required

Whether it’s on the workspace’s Digize bill.

boolean
chargeNote
required
string | null
total
required
number

Example 

{
  "rows": [
    {
      "lines": [
        {
          "design": "printed",
          "format": "card"
        }
      ],
      "status": "in_production",
      "carrier": "USPS"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}