Cancel a card order

POST

/api/v1/cards/orders/{id}/cancel

curl --request POST \
  --url https://digize.com/api/v1/cards/orders/example/cancel \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>'

• Digize

Cancels a card order that hasn’t shipped, and takes it off the workspace’s bill.

Needs the reviews:write permission. It can’t be undone.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Responses

200

Done

Media typeapplication/json

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

string format: date-time

null

null

deliveredAt

required

Any of:

string

string format: date-time

null

null

estimatedAt

required

Any of:

string

string format: date-time

null

null

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

Example

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

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

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

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

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"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

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"
  }
}

422

The Idempotency-Key was used with a different request.

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

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"
  }
}