List sales lines

GET

/sales

const url = 'https://api.europlaybook.com/v1/sales?limit=50&source=api';
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://api.europlaybook.com/v1/sales?limit=50&source=api' \
  --header 'Authorization: Bearer <token>'

Sales lines from every source (API, CSV, shop and ERP connections), oldest first.

Authorizations

BearerTokenAuth

Parameters

Query Parameters

cursor

Any of:

string
null

string

Opaque cursor from next_cursor of the previous page.

limit

Limit

Items per page (1-200).

integer

default: 50 >= 1 <= 200

Items per page (1-200).

sold_from

Any of:

string
null

string format: date

First day (inclusive).

sold_to

Any of:

string
null

string format: date

Last day (inclusive).

sku

Any of:

string
null

string

legal_entity_id

Any of:

string
null

string format: uuid

source

Source

Api = only lines pushed through this API.

string

default: all

Allowed values: api all

Api = only lines pushed through this API.

Responses

200

application/json

SalesPage

object

items

required

Items

Array<object>

SalesLineOut

object

required

string format: uuid

external_id

Any of:

string
null

string

source

required

Source

Where the line came from: api, csv, odoo, shopify, picqer.

string

sku

required

Sku

string

product_id

Any of:

string
null

string format: uuid

legal_entity_id

required

Legal Entity Id

string format: uuid

sold_on

required

Sold On

string format: date

kind

required

Kind

string

Allowed values: sale return

quantity

required

Quantity

integer

ship_from_country

required

Ship From Country

string

ship_to_country

required

Ship To Country

string

channel

required

Channel

string

marketplace

Any of:

string
null

string

buyer_type

required

Buyer Type

string

fulfilment

required

Fulfilment

string

next_cursor

Any of:

string
null

string

Example

{
  "items": [
    {
      "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
      "kind": "sale"
    }
  ],
  "next_cursor": "WyIwMTk5ZjVhMi03YzFlLTdiNGEtOWQwZS0zZjZjMmExYjhlNDQiXQ"
}

400

Bad Request

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

401

Unauthorized

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

403

Forbidden

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

404

Not Found

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

409

Conflict

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

422

Unprocessable Content

application/json

PublicValidationErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

errors

Errors

Per-field problems (pydantic format: loc, msg, type).

Array<object>

default:

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  },
  "errors": []
}

429

Too Many Requests

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}