Retrieve orders

curl --request GET \
  --url https://api.spacebring.com/shop/orders/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "orders": [
    {
      "comment": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "deleteDate": "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": {
        "createDate": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "media": [
          {
            "key": "<string>",
            "url": "<string>"
          }
        ],
        "title": "<string>"
      },
      "quantity": 123,
      "status": "new",
      "user": {
        "about": "<string>",
        "email": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "phoneNumber": "<string>",
        "photoUrl": "<string>",
        "surname": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}

GET

shop

orders

Retrieve orders

curl --request GET \
  --url https://api.spacebring.com/shop/orders/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "orders": [
    {
      "comment": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "deleteDate": "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": {
        "createDate": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "media": [
          {
            "key": "<string>",
            "url": "<string>"
          }
        ],
        "title": "<string>"
      },
      "quantity": 123,
      "status": "new",
      "user": {
        "about": "<string>",
        "email": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "phoneNumber": "<string>",
        "photoUrl": "<string>",
        "surname": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

locationRef

string<uuid>

required

The id of the location.

createDate

object

The date filter of items.

Show child attributes

createDate.lte

string<date-time>

Get orders with less createDate. Example: createDate[lte]=2021-05-21T10:00:00Z

createDate.gte

string<date-time>

Get orders with greater createDate. Example: createDate[gte]=2021-05-21T10:00:00Z

limit

integer<int64>

default:25

The number of items to return

Required range: 1 <= x <= 100

nextPageToken

string

nextPageToken retrieved from a previous request

Response

orders

object[]

Show child attributes

orders.comment

string

orders.createDate

string<date-time>

orders.deleteDate

string<date-time>

orders.id

string<uuid>

orders.locationRef

string<uuid>

orders.membershipRef

string<uuid>

orders.number

number

orders.option

object

Show child attributes

orders.option.id

string<uuid>

orders.option.title

string

orders.payment

object

Show child attributes

orders.payment.amount

number

The amount of the payment

orders.payment.currencyCode

string

The currency code of the payment

orders.payment.invoiceItemRef

string

The reference ID of the invoice item

orders.payment.status

enum<string>

Available options:

succeeded,

pending,

processing,

canceled,

failed

orders.payment.tax

object

Show child attributes

orders.payment.tax.inclusive

boolean

orders.payment.tax.rate

number

orders.payment.transactionRef

string

The reference ID of the transaction

orders.payment.type

enum<string>

Available options:

credits,

dayPasses,

external,

flow,

fondy,

freedompay,

invoice,

kakaopay,

mercadopago,

paypal,

paystack,

plata,

stripe,

tap,

wayforpay

orders.product

object

Show child attributes

orders.product.createDate

string<date-time>

orders.product.description

string

orders.product.id

string<uuid>

orders.product.media

object[]

Show child attributes

orders.product.media.key

string

orders.product.media.url

string

orders.product.title

string

orders.quantity

number

orders.status

enum<string>

Available options:

new,

inProgress,

completed,

canceled

orders.user

object

Show child attributes

orders.user.about

string

orders.user.email

string

orders.user.id

string<uuid>

orders.user.name

string

orders.user.phoneNumber

string

orders.user.photoUrl

string

orders.user.surname

string

nextPageToken

string

Retrieve networks Retrieve plans

⌘I

Getting started

Endpoints

Retrieve orders

OAuth

Authorizations

Headers

Query Parameters

Response