Getting Started
Endpoints
- Benefit Applications
- Benefits
- Bookings
- Companies
- Event Tickets
- Feed Posts
- Invoices
- Invoice Items
- Locations
- Memberships
- Networks
- Orders
- Plans
- Products
- Resources
- Subscriptions
- Support Tickets
- Transactions
- Visitors
Orders
Retrieve orders
Retrieve all orders of products from shop.
OAuth
Required scopes:shop.readonly
or shop
GET
/
shop
/
orders
/
v1
curl --request GET \
--url https://api.spacebring.com/shop/orders/v1 \
--header 'Authorization: Basic <encoded-value>'
{
"orders": [
{
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"payment": {
"amount": 123,
"currencyCode": "<string>",
"invoiceItemRef": "<string>",
"status": "succeeded",
"tax": {
"inclusive": true,
"rate": 123
},
"transactionRef": "<string>",
"type": "credits"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
}
],
"nextPageToken": "<string>"
}
Authorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Query Parameters
The id of the location.
The number of items to return
Required range:
1 < x < 100
nextPageToken retrieved from a previous request
Response
200
application/json
OK
The amount of the payment
The currency code of the payment
The reference ID of the invoice item
Available options:
succeeded
, pending
, processing
, canceled
, failed
The reference ID of the transaction
Available options:
credits
, external
, flow
, fondy
, freedompay
, invoice
, kakaopay
, mercadopago
, paypal
, paystack
, plata
, stripe
, tap
, wayforpay
curl --request GET \
--url https://api.spacebring.com/shop/orders/v1 \
--header 'Authorization: Basic <encoded-value>'
{
"orders": [
{
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"payment": {
"amount": 123,
"currencyCode": "<string>",
"invoiceItemRef": "<string>",
"status": "succeeded",
"tax": {
"inclusive": true,
"rate": 123
},
"transactionRef": "<string>",
"type": "credits"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
}
],
"nextPageToken": "<string>"
}