/customers

The collection of customers

/customers get post

get

Get all customers, optionally filtered

post

Get all customers, optionally filtered

Secured by Bearer token

Token used to authenticate api calls.

Query Parameters

filter: (string)
Order by field: createdAt, updatedAt
Example:
```
filter[createdAt]=date
```
sort: (string)
Allowed sorts: name, email, last_name, points, createdAt, updatedAt
Example:
```
?sort=createdAt
```
page: (string)
Paging by fields:
- size
- number
Example:
```
page[size]=20&page[number]=1
```

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

meta: (object)
- page: (object)
  - currentPage: (integer)
  - from: (integer)
  - lastPage: (integer)
  - perPage: (integer)
  - to: (integer)
  - total: (integer)
json_api: (object)
- version: (string)
links: (object)
- first: (string)
- last: (string)
- next: (string)
data: (array of object)
Items: Customer
- type: (string - default: customers)
- id: (string)
  Customer email
- attributes: (object)
  - name: (string)
  - last_name: (string)
  - email: (string)
  - card: (string)
  - phone: (string)
  - updatedAt: (datetime)
  - createdAt: (datetime)
- relationships: (object)
  Links object with customer relations
- links: (object)
  Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

Secured by Bearer token

Token used to authenticate api calls.

Body

Media type: application/vnd.api+json

Type: object

Properties

type: required(string - default: customers)
attributes: required(object)
- name: required(string)
- last_name: (string)
- email: required(string)
- phone: (string)
- card: (string)
  Auto-generated if not provided.

HTTP status code 201

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: customers)
- id: (string)
  Customer email
- attributes: (object)
  - name: (string)
  - last_name: (string)
  - email: (string)
  - card: (string)
  - phone: (string)
  - updatedAt: (datetime)
  - createdAt: (datetime)
- relationships: (object)
  Links object with customer relations
- links: (object)
  Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email} patch get

The customers resource

patch

Update customer resource

get

Update customer resource

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

type: required(string - default: customers)
id: required(string)
Customer email
attributes: required(object)
- name: (string)
- last_name: (string)
- email: (string)
- phone: (string)
- card: (string)
  Auto-generated if not provided.

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

type: (string - default: customers)
id: (string)
Customer email
attributes: (object)
- name: (string)
- last_name: (string)
- email: (string)
- card: (string)
- phone: (string)
- updatedAt: (datetime)
- createdAt: (datetime)
relationships: (object)
Links object with customer relations
links: (object)
Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: customers)
- id: (string)
  Customer email
- attributes: (object)
  - name: (string)
  - last_name: (string)
  - email: (string)
  - card: (string)
  - phone: (string)
  - updatedAt: (datetime)
  - createdAt: (datetime)
- relationships: (object)
  Links object with customer relations
- links: (object)
  Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/add-points post

post

Add points to customer

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

points: required(integer)
type: required(string)
Custom value that identifies the external service. Example 'Shop ecommerce purchase'
external_id: required(string)
Must be unique. Used to identify especific points registration of external service.
order_id: (string)
content: (object)
Custom metadata

Example:

{
  "points": 10,
  "type": "Custom integration",
  "external_id": "42227616-1c7b-11ee-be56-0242ac120002",
  "order_id": "order_12345",
  "content": {
    "\\\"integration_transaction_url\\\"": "\\\"url\\\""
  }
}

HTTP status code 200

Customer resource

Body

Media type: application/vnd.api+json

Type: object

Properties

type: (string - default: customers)
id: (string)
Customer email
attributes: (object)
- name: (string)
- last_name: (string)
- email: (string)
- card: (string)
- phone: (string)
- updatedAt: (datetime)
- createdAt: (datetime)
relationships: (object)
Links object with customer relations
links: (object)
Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/add-points-from-value post

post

Add points with a decimal value. The conversion to points will be donde automatically.

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

value: required(number)
type: required(string - maxLength: 255)
Custom value that identifies the external service. Example 'Shop ecommerce purchase'
external_id: (string - maxLength: 255)
Must be unique. Used to identify especific points registration of external service.
order_id: (string - maxLength: 255)
If not set, external_id value will be used.
items: (array of Item)
Sku or Ids of products that compose the order.
metadata: (object)
Custom metadata

HTTP status code 200

Customer resource

Body

Media type: application/vnd.api+json

Type: object

Properties

type: (string - default: customers)
id: (string)
Customer email
attributes: (object)
- name: (string)
- last_name: (string)
- email: (string)
- card: (string)
- phone: (string)
- updatedAt: (datetime)
- createdAt: (datetime)
relationships: (object)
Links object with customer relations
links: (object)
Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/subtract-points post

post

Subtract points from customer

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

points: required(number)
type: required(string - maxLength: 255)
Custom value that identifies the external service. Example 'Shop ecommerce purchase'
external_id: (string - maxLength: 255)
Must be unique. Used to identify especific points registration of external service.
order_id: (string - maxLength: 255)
If not set, uses external_id value
content: (object)
Custom metadata

HTTP status code 200

Customer resource

Body

Media type: application/vnd.api+json

Type: object

Properties

type: (string - default: customers)
id: (string)
Customer email
attributes: (object)
- name: (string)
- last_name: (string)
- email: (string)
- card: (string)
- phone: (string)
- updatedAt: (datetime)
- createdAt: (datetime)
relationships: (object)
Links object with customer relations
links: (object)
Action links for customer

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/barcode post

post

Get a data:url of the card number representation in QR or barcode

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

type: required(string)
Posible values:
- CQR: For QR type.
- C128: For barcode type.

HTTP status code 200

Body

Media type: application/dataurl

Type: string

Example:

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIIAAACCCAIAAAAFYYeqAAAACXBIWXMAAA7EAAAOxAGVKw4bAAACSUlEQVR4nO3dwW7DIBAAUVPl/3/ZPfTGIWK9CwzuvGubxNEIIbAdt/u+L+32s/sAdF1mgDADghkQzIBgBgQzIJgBwQwIZkAwA8Jn5J9aa7OP40/hBld3zN07076RowHBDAhmQDADwtAU3Zk3kWZemzmq7d/I0YBgBgQzIJgB4ckU3QlNSvMuBClcGK//Ro4GBDMgmAHBDAgFU/Q8oXXyrq3sEo4GBDMgmAHBDAjoKbpTuLNN42hAMAOCGRDMgFAwRc+bKkMLY+ap6UGOBgQzIJgBwQwIT6boZXvIoauyQ3/9/kHrORoQzIBgBgQzILQ3bRefy9GAYAYEMyCYAaHgvujQJD/vYunCje7C7zvI0YBgBgQzIJgB4ckqOjSDZWbOeZvVobdasNHgaEAwA4IZEMyAULDRnVlzFv4GWOZMdeitQocxyNGAYAYEMyCYAaF+Fd2BLJszFuy3OxoQzIBgBgQzIDw5F124Xg2Z90GZu7tKOBoQzIBgBgQzIKCv6F5201Xoc2e81tGAYAYEMyCYAeHgJ10tm7E739/Kc9EHMwOCGRDMgHDwk646mV/w3n6HlqMBwQwIZkAwAwL6SVeZy8V2nTB3FX0wMyCYAcEMCO95jEb318wlX6EFeQlHA4IZEMyAYAaEk6bowrmx8KdL3Oh+DzMgmAHBDAjoJ13N+yHO0CVfmX8e5GhAMAOCGRDMgIB+0lXIvAvCMjP2IEcDghkQzIBgBgT0fdH/h6MBwQwIZkAwA4IZEMyAYAYEMyCYAcEMCGZAMAPCLwwDBgYSjAkQAAAAAElFTkSuQmCC

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/transactions get

The collection of transactions

get

List of customer transactions

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Query Parameters

page: (string)
Paging by fields:
- size
- number
Example:
```
page[size]=20&page[number]=1
```
filter: (string)
Order by field: external_id, type, action, order_id
Example:
```
filter[action]=addition
```
sort: (string)
Allowed sorts: external_id, order_id, action, type, amount, points, exchange, total_points, created_at
Example:
```
?sort=-external_id (desc) ?sort=external_id (asc)
```

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

meta: (object)
- page: (object)
  - currentPage: (integer)
  - from: (integer)
  - lastPage: (integer)
  - perPage: (integer)
  - to: (integer)
  - total: (integer)
json_api: (object)
- version: (string)
links: (object)
- first: (string)
- last: (string)
- next: (string)
data: (array of object)
Items: Transaction
- type: (string - default: transactions)
- id: (string)
  Transaction id
- attributes: (object)
  - external_id: (string)
    Must be unique. Used to identify especific points registration.
  - order_id: (string)
    If not set uses external_id.
  - action: (string)
    The values could be either 'addition' or 'subtraction'
  - type: (string)
    Custom value that identifies the external service. Example 'Shop ecommerce purchase'
  - points: (number)
    Points added
  - amount: (number)
    Float value to exchange to points.
  - exchange: (number)
    The float value that represents one point. This is use when adding points from a float value.
  - total_points: (number)
    Customer total point after the transaction.
  - created_at: (datetime)

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/customers/{email}/relationships/transactions get

get

List of customer transactions

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

email: required(string)

Query Parameters

page: (string)
Paging by fields:
- size
- number
Example:
```
page[size]=20&page[number]=1
```

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Example:

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://subdomain.omniwallet.net/api/v1/customers/customer@email.com/relationships/transactions",
    "related": "https://subdomain.omniwallet.net/api/v1/customers/customer@email.com/transactions"
  },
  "data": [
    {
      "type": "transactions",
      "id": "1"
    },
    {
      "type": "transactions",
      "id": "5"
    }
  ]
}

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/settings

The collection of settings

/settings get

get

Get all settings, optionally filtered

Secured by Bearer token

Token used to authenticate api calls.

Query Parameters

page: (string)
Paging by fields:
- size
- number
Example:
```
page[size]=20&page[number]=1
```
filter: (string)
Order by field: key
Example:
```
filter[key]=POINTS_VALUE
```

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

meta: (object)
- page: (object)
  - currentPage: (integer)
  - from: (integer)
  - lastPage: (integer)
  - perPage: (integer)
  - to: (integer)
  - total: (integer)
json_api: (object)
- version: (string)
links: (object)
- first: (string)
- last: (string)
- next: (string)
data: (array of object)
Items: Setting
- type: (string - default: settings)
- id: (string)
  Setting identification key
- attributes: (object)
  - value: (string)
    Configuration value

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/settings/{setting} get

The settings resource

get

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

setting: required(string)

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: settings)
- id: (string)
  Setting identification key
- attributes: (object)
  - value: (string)
    Configuration value

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/orders

The collection of orders

/orders get post

get

Get all orders, optionally filtered

post

Get all orders, optionally filtered

Secured by Bearer token

Token used to authenticate api calls.

Query Parameters

filter: (string)
Order by field: created_at, updated_at, status
Example:
```
filter[status]=pending
```
sort: (string)
Allowed sorts: customer, status, home_delivery, total_points, created_at, updated_at
Example:
```
?sort=createdAt
```
page: (string)
Paging by fields:
- size
- number
Example:
```
page[size]=20&page[number]=1
```

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

meta: (object)
- page: (object)
  - currentPage: (integer)
  - from: (integer)
  - lastPage: (integer)
  - perPage: (integer)
  - to: (integer)
  - total: (integer)
json_api: (object)
- version: (string)
links: (object)
- first: (string)
- last: (string)
- next: (string)
data: (array of object)
Items: Order
- type: (string - default: orders)
- id: (string)
  Order ID
- attributes: (object)
  - customer: (string)
    Customer email
  - status: (string - default: pending)
    Only values, pending, completed, sent or cancelled.
  - home_delivery: (boolean)
    True if the shipping addres, is a home address. False will be considered as a shop address
  - shipping_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - invoice_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - products: (array of OrderProduct)
    Items: OrderProduct
    sku: (string)
    The sku must exists within the products created in the platform
    quantity: (number)
    points: (number)
    How much points the product costs.
    total_points: (number)
    points * quantity
  - total_points: (number)
  - updated_at: (datetime)
  - created_at: (datetime)
  - comments: (string - maxLength: 1000)

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

Secured by Bearer token

Token used to authenticate api calls.

Body

Media type: application/vnd.api+json

Type: object

Properties

type: required(string - default: orders)
attributes: required(object)
- customer: required(string)
  Customer email. The email must exist
- home_delivery: required(boolean)
  True if the shipping addres, is a home address. False will be considered as a shop address
- status: required(string - default: pending)
  Only values, pending, completed, sent or cancelled.
- shipping_address: required(object)
  - address: required(string)
  - city: required(string)
  - province: required(string)
  - postal_code: required(string)
  - country: required(string)
    ISO 3166
- invoice_address: required(object)
  - address: required(string)
  - city: required(string)
  - province: required(string)
  - postal_code: required(string)
  - country: required(string)
    ISO 3166
- products: required(array of OrderProductPost)
  Items: OrderProductPost
  - sku: required(string)
    The sku must exists within the products created in the platform
  - quantity: required(number)
  - points: required(number)
    How much points the product costs.
  - total_points: required(number)
    points * quantity
- total_points: required(number)
- comments: required(string - maxLength: 1000)

HTTP status code 201

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: orders)
- id: (string)
  Order ID
- attributes: (object)
  - customer: (string)
    Customer email
  - status: (string - default: pending)
    Only values, pending, completed, sent or cancelled.
  - home_delivery: (boolean)
    True if the shipping addres, is a home address. False will be considered as a shop address
  - shipping_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - invoice_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - products: (array of OrderProduct)
    Items: OrderProduct
    - sku: (string)
      The sku must exists within the products created in the platform
    - quantity: (number)
    - points: (number)
      How much points the product costs.
    - total_points: (number)
      points * quantity
  - total_points: (number)
  - updated_at: (datetime)
  - created_at: (datetime)
  - comments: (string - maxLength: 1000)

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

/orders/{order_id} patch get

The orders resource

patch

get

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

order_id: required(string)

Body

Media type: application/vnd.api+json

Type: object

Properties

type: required(string - default: orders)
id: required(string)
Order ID.
attributes: required(object)
- home_delivery: (boolean)
  True if the shipping addres, is a home address. False will be considered as a shop address
- status: (string - default: pending)
  Only values, pending, completed, sent or cancelled.
- shipping_address: (object)
  - address: (string)
  - city: (string)
  - province: (string)
  - postal_code: (string)
  - country: (string)
    ISO 3166
- invoice_address: (object)
  - address: (string)
  - city: (string)
  - province: (string)
  - postal_code: (string)
  - country: (string)
    ISO 3166
- total_points: (number)
- comments: (string - maxLength: 1000)

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: orders)
- id: (string)
  Order ID
- attributes: (object)
  - customer: (string)
    Customer email
  - status: (string - default: pending)
    Only values, pending, completed, sent or cancelled.
  - home_delivery: (boolean)
    True if the shipping addres, is a home address. False will be considered as a shop address
  - shipping_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - invoice_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - products: (array of OrderProduct)
    Items: OrderProduct
    - sku: (string)
      The sku must exists within the products created in the platform
    - quantity: (number)
    - points: (number)
      How much points the product costs.
    - total_points: (number)
      points * quantity
  - total_points: (number)
  - updated_at: (datetime)
  - created_at: (datetime)
  - comments: (string - maxLength: 1000)

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

Secured by Bearer token

Token used to authenticate api calls.

URI Parameters

order_id: required(string)

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Properties

json_api: (object)
- version: (string)
links: (object)
- self: (string)
data: (object)
- type: (string - default: orders)
- id: (string)
  Order ID
- attributes: (object)
  - customer: (string)
    Customer email
  - status: (string - default: pending)
    Only values, pending, completed, sent or cancelled.
  - home_delivery: (boolean)
    True if the shipping addres, is a home address. False will be considered as a shop address
  - shipping_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - invoice_address: (object)
    - address: (string)
    - city: (string)
    - province: (string)
    - postal_code: (string)
    - country: (string)
      ISO 3166
  - products: (array of OrderProduct)
    Items: OrderProduct
    - sku: (string)
      The sku must exists within the products created in the platform
    - quantity: (number)
    - points: (number)
      How much points the product costs.
    - total_points: (number)
      points * quantity
  - total_points: (number)
  - updated_at: (datetime)
  - created_at: (datetime)
  - comments: (string - maxLength: 1000)

Secured by Bearer token

Headers

Authorization: required(string)
Example:
```
Authorization: Bearer {token}
```

Omniwallet API

/customers

get /customers

Query Parameters

HTTP status code 200

Body

Secured by Bearer token

Headers

post /customers

Body

HTTP status code 201

Body

Secured by Bearer token

Headers

patch /customers/{email}

URI Parameters

Body

HTTP status code 200

Body

Secured by Bearer token

Headers

get /customers/{email}

URI Parameters

HTTP status code 200

Body

Secured by Bearer token

Headers

post /customers/{email}/add-points

URI Parameters

Body

HTTP status code 200

Body

Secured by Bearer token

Headers

post /customers/{email}/add-points-from-value

URI Parameters

Body

HTTP status code 200

Body

Secured by Bearer token

Headers

post /customers/{email}/subtract-points

URI Parameters

Body

HTTP status code 200

Body

Secured by Bearer token

Headers

post /customers/{email}/barcode

URI Parameters

Body

HTTP status code 200

Body

Secured by Bearer token

Headers

get /customers/{email}/transactions

URI Parameters

Query Parameters

HTTP status code 200

Body

Secured by Bearer token

Headers

get /customers/{email}/relationships/transactions

URI Parameters

Query Parameters

HTTP status code 200

Body

Secured by Bearer token

Headers

/settings

get /settings

Query Parameters

HTTP status code 200

Body

Secured by Bearer token

Headers

get /settings/{setting}

URI Parameters

HTTP status code 200

Body