List paid shop orders that have not come into Bottle

GET

/shop-orders/held

curl --request GET \
  --url https://example.com/shop-orders/held \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Paid in the shop, not fulfilled there, and held before becoming an order here, oldest first. Each says why, and for one held by its products, which products.

Authorizations

• sessionCookie
  orders:read
• apiKey
  orders:read

Responses

200

Up to 50 held orders

Media typeapplication/json

object

items

required

Array<object>

object

shopId

required

UUID v7

string format: uuid

shopName

required

string

externalOrderId

required

string

externalRef

required

string | null

reason

required

string | null

heldSince

required

string format: date-time

heldBy

required

Array<object>

object

name

required

string

productId

required

UUID v7

string | null format: uuid

archived

required

boolean

Example

{
  "items": [
    {
      "shopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "heldBy": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ]
}

401

Sign in required

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Only an owner or admin can manage order imports

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Shop not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Order worker temporarily unavailable

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}