Orders, newest first, with their download links

GET

/api/v1/workspaces/{workspace}/products/orders

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/products/orders?status=&period=7d&page=1&pageSize=10"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/products/orders?status=&period=7d&page=1&pageSize=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/products/orders?status=&period=7d&page=1&pageSize=10' \
  --header 'Authorization: Bearer <token>'

Permission: products:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Query Parameters

An order number or part of the buyer’s email

string

<= 200 characters

An order number or part of the buyer’s email

product

A product’s id

string

A product’s id

status

string

Allowed values: "" paid refunded partially_refunded disputed test

period

string

default: 30d

Allowed values: 7d 30d 90d all

page

integer format: int64

default: 1 >= 1

pageSize

integer format: int64

default: 10 >= 1 <= 100

Responses

200

application/json

object

items

required

Array<object>

object

amountCents

required

integer format: int64

buyerEmail

required

string

currency

required

string

disputeReason

required

string

disputeStatus

required

string

Allowed values: "" open won lost

disputedAt

string format: date-time

download

required

object

allowed

required

integer format: int32

deliveredAt

string format: date-time

error

string

expiresAt

string format: date-time

newLink

required

boolean

newLinkAt

string format: date-time

newLinkBy

required

string

provider

required

string

revokeReason

required

string

Allowed values: "" manual refund dispute

revokedAt

string format: date-time

revokedBy

required

string

sentAt

string format: date-time

state

required

string

Allowed values: pending sent delivered failed expired used_up revoked revoked_auto

used

required

integer format: int32

required

string

number

required

integer format: int64

paidAt

required

string format: date-time

payWhatYouWant

required

boolean

product

required

The product’s short name (Field Guide)

string

productId

required

string

productName

required

string

refundedAt

string format: date-time

refundedCents

required

integer format: int64

status

required

string

Allowed values: paid refunded partially_refunded disputed

test

required

boolean

page

required

integer format: int64

pageSize

required

integer format: int64

products

required

Array<object>

object

count

required

integer format: int64

name

required

string

productId

required

string

total

required

integer format: int64

Example

{
  "items": [
    {
      "disputeStatus": "",
      "download": {
        "revokeReason": "",
        "state": "pending"
      },
      "status": "paid"
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}