Skip to main content
GET
/
api
/
admin
/
merch
/
orders
Admin list merch orders by site
curl --request GET \
  --url https://api.sprucecollective.co.uk/api/admin/merch/orders \
  --header 'Authorization: <api-key>'
[
  {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "callback_url": "<string>",
    "charges": {},
    "checkout_id": "<string>",
    "country_code": "<string>",
    "created_at": "<string>",
    "id": "<string>",
    "items": [
      {
        "assets": {},
        "attributes": {},
        "copies": 123,
        "created_at": "<string>",
        "id": "<string>",
        "merch_order_id": "<string>",
        "merch_product_id": "<string>",
        "recipient_cost_amount": 123,
        "recipient_cost_currency": "<string>",
        "sizing": "<string>",
        "sku": "<string>",
        "updated_at": "<string>"
      }
    ],
    "metadata": {},
    "payment_id": "<string>",
    "postal_or_zip_code": "<string>",
    "prodigi_order_id": "<string>",
    "recipient_email": "<string>",
    "recipient_name": "<string>",
    "recipient_phone": "<string>",
    "shipments": {},
    "shipping_method": "<string>",
    "site_id": "<string>",
    "state_or_county": "<string>",
    "status_details": {},
    "status_stage": "<string>",
    "town_or_city": "<string>",
    "updated_at": "<string>",
    "user_id": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Query Parameters

site_id
string
required

Site ID

Response

200 - application/json

OK

address_line1
string
address_line2
string
callback_url
string
charges
object
checkout_id
string
country_code
string
created_at
string
id
string
items
object[]
metadata
object
payment_id
string
postal_or_zip_code
string
prodigi_order_id
string
recipient_email
string
recipient_name
string
recipient_phone
string
shipments
object
shipping_method
string
site_id
string
state_or_county
string
status_details
object
status_stage
string
town_or_city
string
updated_at
string
user_id
string