API docs by Redocly

Trébol eCommerce API (3.0.0)

Download OpenAPI specification:Download

Benjamin La Madrid: bg.lamadrid@gmail.com License: GNU GPLv3

A collection of resources that the Trébol backend exposes to interact with. Depends on, and references Trébol eCommerce API Commons v1.0.0

preflight

Preflight check for people API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for non-specific product API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Responses

Preflight check for non-specific order API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
buyOrder
integer

The unique number associated to an order.

Responses

Preflight check for Order confirmation API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for Order rejection API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for Order completion API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for non-specific user API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Responses

Preflight check for non-specific image API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for user roles API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for shop information

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for payment request

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for payment confirmation

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for specific transaction receipt

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
path Parameters
code
required
string

The transaction identifier

Responses

Preflight check for root product categories API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Responses

Preflight check for user profile information

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for billing types API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None

Responses

Preflight check for shipper API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Responses

Preflight check for root product lists API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Responses

Preflight check for root product lists API

Fetch OPTIONS for communicating with this resource.

Authorizations:
None
query Parameters
listCode
required
string

The exact code of the list

Responses

transaction

Send a payment request

POST cart details to initiate a virtual transaction in the shop.

Authorizations:
AuthorizedRequest
query Parameters
method
required
string
Examples:
  • method="webpay" -

The payment method requested by the user.

Request Body schema: application/json
required
Array
required
object (Product)

A physical item or a service that the shop offers to the public.

units
required
integer

The amount, or quantity of the related product.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "url": "https://payment.com",
  • "token_ws": "a.token.that.the.payment.method.created.and.recognizes"
}

Send payment result

POST (ping) response from the payment method to confirm the transaction end result.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Find specific transaction receipt

GET complete public information about a transaction, matched by its ID, code, or whatever unique property is used to identify it.

Authorizations:
None
path Parameters
code
required
string

The transaction identifier

Responses

Response samples

Content type
application/json
{
  • "buyOrder": 1,
  • "totalValue": 11000,
  • "taxValue": 1000,
  • "transportValue": 0,
  • "status": "complete",
  • "date": "2020-12-25 15:40:53 GMT",
  • "details": [
    ]
}

metadata

Request info on the shop

GET general information regarding the company behind the shop.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "name": "example shop owner details",
  • "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse arcu eros, semper id interdum ut, molestie ut ex. Nulla lobortis viverra tempor.",
  • "bannerImageURL": "https://example.com/banner.jpg",
  • "logoImageURL": "https://example.com/logo.jpg"
}

account

Fetch current user's profile

GET the current user's stored profile information

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
{
  • "firstName": "Isaac Sebastian",
  • "lastName": "Williams McGregor",
  • "idNumber": "123456789-0",
  • "email": "example@email.com",
  • "phone1": "(+512)784 876 823",
  • "phone2": "4444 9820"
}

Update current user's profile

PUT changes into the current user's profile information.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
email
required
string

The e-mail address.

phone1
string^(\(\+?(\d{3}|\d{2} ?\d)\)|\+?\d{3}|\+?\d{2}[...

The preferred personal phone number

phone2
string^(\(\+?(\d{3}|\d{2} ?\d)\)|\+?\d{3}|\+?\d{2}[...

A second phone number

idNumber
required
string

The national identification number as issued by the individual's birth country government.

firstName
required
string

The individual's first name.

lastName
required
string

The individual's last or family name.

Responses

Request samples

Content type
application/json
{
  • "firstName": "Isaac Sebastian",
  • "lastName": "Williams McGregor",
  • "idNumber": "123456789-0",
  • "email": "example@email.com",
  • "phone1": "(+512)784 876 823",
  • "phone2": "4444 9820"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

create

Insert new products

POST a new product entity and save it to the data store

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new orders

POST a new order entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new users

POST a new user entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
required
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "an username",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new images

POST a new image entity and save it to the data store

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
required
string

The file name of the image.

url
required
string

The URL to find the image at.

code
required
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new product categories

POST a new product category entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
required
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "code": 3,
  • "name": "example category",
  • "parent": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new shippers

POST a new shipper entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "some text"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new product lists

POST a new product list entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
required
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "name": "example list",
  • "code": "EXAMPLE001",
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert product into a list

POST a product entity and save it to the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

read-one

Fetch current user's profile

GET the current user's stored profile information

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
{
  • "firstName": "Isaac Sebastian",
  • "lastName": "Williams McGregor",
  • "idNumber": "123456789-0",
  • "email": "example@email.com",
  • "phone1": "(+512)784 876 823",
  • "phone2": "4444 9820"
}

read-many

List people

GET a paged collection of people.

Authorizations:
AuthorizedRequest
query Parameters
pageSize
integer

Number of people per page

pageIndex
integer

Index of page (0-based)

sortBy
string

People property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

People sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List products

GET a paged collection of products.

Authorizations:
None
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

pageSize
integer

Number of products per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Product property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Product sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List orders

GET a paged collection of orders.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

pageSize
integer

Number of orders per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Order property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Sort order direction (ascending or descending)

date
string <date-time>

The exact date & time of transaction. If invoked, afterDate and beforeDate parameters are ignored.

afterDate
string <date-time>

Minimum date & time to account transactions by (datetime range start)

beforeDate
string <date-time>

Limit date & time to account transactions by (datetime range end)

statusCode
integer

Numeric status code (such as pending, paid, delivered)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List users

GET a paged collection of users.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

pageSize
integer

Number of users per page

pageIndex
integer

Index of page (0-based)

sortBy
string

User property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

User sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List images

GET a paged collection of images.

Authorizations:
AuthorizedRequest
query Parameters
pageSize
integer

Number of images per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Sort order (ascending/descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List all user roles

GET every user role available.

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List product categories

GET a paged collection of product categories. By default, it fetches parent-less categories first.

Authorizations:
None
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all billing types

GET every billing type available.

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List shippers

GET a paged collection of shippers.

Authorizations:
None
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

pageSize
integer

Number of users per page

pageIndex
integer

Index of page (0-based)

sortBy
string

User property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

User sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

List product lists

GET a paged collection of product lists.

Authorizations:
None
query Parameters
pageSize
integer

Number of lists per page

pageIndex
integer

Index of page (0-based)

sortBy
string

List property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Lists sort order (ascending or descending)

code
string

The exact code of a list. Case sensitive.

name
string

The exact name of a list. Case sensitive.

codeLike
string

A portion of a list's code. Case insensitive.

nameLike
string

A portion of a list's name. Case insensitive.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch products stored in a list

GET a paged collection of product within a list's contents.

Authorizations:
None
query Parameters
listCode
required
string

The exact code of the list

pageSize
integer

Number of products per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Product property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Product sort order (ascending or descending)

productCode
string

The exact code of a product. Case sensitive.

productCodeLike
string

A portion of a product's code. Case insensitive.

productNameLike
string

A portion of a product's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

update

Update products

PUT changes to all products matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update orders

PUT changes to all orders matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update users

PUT changes to all users matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
required
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "an username",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update images

PUT changes to all images matching the provided query parameters.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
required
string

The file name of the image.

url
required
string

The URL to find the image at.

code
required
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update product categories

PUT changes to all product categories matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
required
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "code": 3,
  • "name": "example category",
  • "parent": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update current user's profile

PUT changes into the current user's profile information.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
email
required
string

The e-mail address.

phone1
string^(\(\+?(\d{3}|\d{2} ?\d)\)|\+?\d{3}|\+?\d{2}[...

The preferred personal phone number

phone2
string^(\(\+?(\d{3}|\d{2} ?\d)\)|\+?\d{3}|\+?\d{2}[...

A second phone number

idNumber
required
string

The national identification number as issued by the individual's birth country government.

firstName
required
string

The individual's first name.

lastName
required
string

The individual's last or family name.

Responses

Request samples

Content type
application/json
{
  • "firstName": "Isaac Sebastian",
  • "lastName": "Williams McGregor",
  • "idNumber": "123456789-0",
  • "email": "example@email.com",
  • "phone1": "(+512)784 876 823",
  • "phone2": "4444 9820"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update shippers

PUT changes to all shippers matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "some text"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update product lists

PUT changes to all product lists matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
required
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "name": "example list",
  • "code": "EXAMPLE001",
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Update full contents of a list

PUT provided products to replace the entire contents of the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

Request Body schema: application/json
required
Array
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

partial-update

Partially update a product

PATCH changes to the product matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
string

The given name of the product.

barcode
string

A unique identifier for the product. Normally issued by an external ERP service.

price
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "barcode": "string",
  • "price": 0,
  • "images": [],
  • "code": "string",
  • "category": {
    },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update an order

PATCH changes into an order matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "details": [
    ],
  • "billingType": "string",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "paymentType": "string",
  • "salesperson": {
    },
  • "billingCompany": {
    },
  • "netValue": 0,
  • "status": "string",
  • "buyOrder": 0,
  • "customer": {
    },
  • "taxValue": 0,
  • "totalValue": 0,
  • "totalItems": 0,
  • "token": "string",
  • "transportValue": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partial update an user

PATCH changes into the user matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "person": {
    },
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update an image

PATCH changes into the image tahat matches the provided query parameters.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
string

The file name of the image.

url
string

The URL to find the image at.

code
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a product category

PATCH changes into the product category matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent": { },
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a shipper

PATCH changes into the shipper matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a product list

PATCH changes to the product list matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "totalCount": 0,
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

delete

Delete products

DELETE products matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete orders

DELETE orders matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete users

DELETE users matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete images

DELETE images matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete product categories

DELETE product categories matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete shippers

DELETE shippers matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete product lists

DELETE product listsmatching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Remove products from a list

DELETE products matching the provided query parameters, from the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

productCode
string

The exact code of a product. Case sensitive.

productCodeLike
string

A portion of a product's code. Case insensitive.

productNameLike
string

A portion of a product's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

billing-types

List all billing types

GET every billing type available.

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

images

List images

GET a paged collection of images.

Authorizations:
AuthorizedRequest
query Parameters
pageSize
integer

Number of images per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Sort order (ascending/descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update images

PUT changes to all images matching the provided query parameters.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
required
string

The file name of the image.

url
required
string

The URL to find the image at.

code
required
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new images

POST a new image entity and save it to the data store

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
required
string

The file name of the image.

url
required
string

The URL to find the image at.

code
required
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update an image

PATCH changes into the image tahat matches the provided query parameters.

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
filename
string

The file name of the image.

url
string

The URL to find the image at.

code
string

Unique identifier of the image. Allows URL-compatible characters only.

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete images

DELETE images matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

products

List products

GET a paged collection of products.

Authorizations:
None
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

pageSize
integer

Number of products per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Product property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Product sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update products

PUT changes to all products matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new products

POST a new product entity and save it to the data store

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a product

PATCH changes to the product matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Request Body schema: application/json
required
name
string

The given name of the product.

barcode
string

A unique identifier for the product. Normally issued by an external ERP service.

price
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "barcode": "string",
  • "price": 0,
  • "images": [],
  • "code": "string",
  • "category": {
    },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete products

DELETE products matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
barcode
string

The exact barcode of the product. Case sensitive.

barcodeLike
string

A portion of the product's barcode. Case insensitive.

name
string

The exact name of the product. Case sensitive.

nameLike
string

A portion the product's name. Case insensitive.

categoryCode
string

The exact code of the product's category. Case sensitive.

categoryCodeLike
string

A portion of the product category's code. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

product-categories

List product categories

GET a paged collection of product categories. By default, it fetches parent-less categories first.

Authorizations:
None
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update product categories

PUT changes to all product categories matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
required
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "code": 3,
  • "name": "example category",
  • "parent": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new product categories

POST a new product category entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
required
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "code": 3,
  • "name": "example category",
  • "parent": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a product category

PATCH changes into the product category matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Request Body schema: application/json
required
name
string

The name displayed for the category.

parent
object (ProductCategoryProperties) Recursive
code
string

A unique identifier for the category.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent": { },
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete product categories

DELETE product categories matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
parentCode
string

The code of a parent category. If left empty, no exclusions are made.

Valid numbers exclude root categories. null makes it so only root categories are included.

code
string

The code of the category. When specified, rules out all other query parameters.

name
string

The exact name of the category. Case sensitive.

nameLike
string

A portion of the category's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

product-lists

List product lists

GET a paged collection of product lists.

Authorizations:
None
query Parameters
pageSize
integer

Number of lists per page

pageIndex
integer

Index of page (0-based)

sortBy
string

List property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Lists sort order (ascending or descending)

code
string

The exact code of a list. Case sensitive.

name
string

The exact name of a list. Case sensitive.

codeLike
string

A portion of a list's code. Case insensitive.

nameLike
string

A portion of a list's name. Case insensitive.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update product lists

PUT changes to all product lists matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
required
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "name": "example list",
  • "code": "EXAMPLE001",
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new product lists

POST a new product list entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
required
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "name": "example list",
  • "code": "EXAMPLE001",
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a product list

PATCH changes to the product list matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Request Body schema: application/json
required
totalCount
integer

The total amount of products in the list

name
string

Unique name of the list

code
string

Unique code of the list

Responses

Request samples

Content type
application/json
{
  • "totalCount": 0,
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete product lists

DELETE product listsmatching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
code
string

The exact code of the list

name
string

The exact name of the list. Case sensitive.

nameLike
string

A portion of the list name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Fetch products stored in a list

GET a paged collection of product within a list's contents.

Authorizations:
None
query Parameters
listCode
required
string

The exact code of the list

pageSize
integer

Number of products per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Product property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Product sort order (ascending or descending)

productCode
string

The exact code of a product. Case sensitive.

productCodeLike
string

A portion of a product's code. Case insensitive.

productNameLike
string

A portion of a product's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update full contents of a list

PUT provided products to replace the entire contents of the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

Request Body schema: application/json
required
Array
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert product into a list

POST a product entity and save it to the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

Request Body schema: application/json
required
name
required
string

The given name of the product.

barcode
required
string

A unique identifier for the product. Normally issued by an external ERP service.

price
required
number

The price of the product, valued by the store's local currency.

Array of objects (Image)

A list of images that illustrate this product.

code
string

A unique identifier for the product. Read-only after creation.

object (ProductCategory)

A Product group/category. Each one can be divided into smaller subsets (ProductType).

description
string

A summary of the product qualities

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Remove products from a list

DELETE products matching the provided query parameters, from the list.

Authorizations:
AuthorizedRequest
query Parameters
listCode
required
string

The exact code of the list

productCode
string

The exact code of a product. Case sensitive.

productCodeLike
string

A portion of a product's code. Case insensitive.

productNameLike
string

A portion of a product's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

people

List people

GET a paged collection of people.

Authorizations:
AuthorizedRequest
query Parameters
pageSize
integer

Number of people per page

pageIndex
integer

Index of page (0-based)

sortBy
string

People property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

People sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

orders

List orders

GET a paged collection of orders.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

pageSize
integer

Number of orders per page

pageIndex
integer

Index of page (0-based)

sortBy
string

Order property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

Sort order direction (ascending or descending)

date
string <date-time>

The exact date & time of transaction. If invoked, afterDate and beforeDate parameters are ignored.

afterDate
string <date-time>

Minimum date & time to account transactions by (datetime range start)

beforeDate
string <date-time>

Limit date & time to account transactions by (datetime range end)

statusCode
integer

Numeric status code (such as pending, paid, delivered)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update orders

PUT changes to all orders matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new orders

POST a new order entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update an order

PATCH changes into an order matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Request Body schema: application/json
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "details": [
    ],
  • "billingType": "string",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "paymentType": "string",
  • "salesperson": {
    },
  • "billingCompany": {
    },
  • "netValue": 0,
  • "status": "string",
  • "buyOrder": 0,
  • "customer": {
    },
  • "taxValue": 0,
  • "totalValue": 0,
  • "totalItems": 0,
  • "token": "string",
  • "transportValue": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete orders

DELETE orders matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
buyOrder
integer

The unique number associated to an order.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Confirm orders

POST confirmation of a given order

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Reject orders

POST rejection of a given order

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Finish completed orders

POST completion of a given order

Authorizations:
AuthorizedRequest
Request Body schema: application/json
required
required
Array of objects (Root Type for OrderDetail)

A list that provides full information about the acquired products or services.

billingType
string

The name of the chosen method for generating a bill of the order.

object (Root Type for Address)

Information about a physical address.

object (Root Type for Address)

Information about a physical address.

object (Shipper)

External representatives that handle shipping.

date
required
string <date-time>

(UTC) The date and time that the transaction was acknowledged.

paymentType
required
string

The selected method for payment for this transaction.

object (Person)

Personal information about an individual.

object (Root Type for BillingCompany)

A company or similar organization, enabled to pay taxes.

netValue
number

The total value derived from the products included at the moment of transaction.

status
string

The step that the transaction is in.

buyOrder
integer

Unique transaction identifier.

required
object (Person)

Personal information about an individual.

taxValue
number

The amount of income destined to pay taxes.

totalValue
number

The sum between net, transport and taxes values.

totalItems
integer

The sum amount of product units purchased.

token
string

An unique code that identifies the transaction.

transportValue
number

The amount paid for transport.

Responses

Request samples

Content type
application/json
{
  • "buyOrder": 1,
  • "details": [
    ],
  • "billingType": "some text",
  • "billingAddress": {
    },
  • "billingCompany": {
    },
  • "shippingAddress": {
    },
  • "shipper": {
    },
  • "status": "Pending",
  • "date": "2018-02-10T09:30Z",
  • "paymentType": "some payment method",
  • "customer": {
    },
  • "salesperson": {
    },
  • "token": "ANSDg900viery9e",
  • "netValue": 549.99,
  • "taxValue": 30.15,
  • "transportValue": 0,
  • "totalValue": 580.14,
  • "totalItems": 42
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

shippers

List shippers

GET a paged collection of shippers.

Authorizations:
None
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

pageSize
integer

Number of users per page

pageIndex
integer

Index of page (0-based)

sortBy
string

User property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

User sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update shippers

PUT changes to all shippers matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "some text"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new shippers

POST a new shipper entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
required
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "some text"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partially update a shipper

PATCH changes into the shipper matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Request Body schema: application/json
required
name
string

The name of the representative.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete shippers

DELETE shippers matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the shipper. Case sensitive.

nameLike
string

A portion of the shipper's name. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

users

List users

GET a paged collection of users.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

pageSize
integer

Number of users per page

pageIndex
integer

Index of page (0-based)

sortBy
string

User property to sort by

order
string
Examples:
  • order="asc" -
  • order="desc" -

User sort order (ascending or descending)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 2,
  • "totalCount": 32,
  • "pageSize": 15
}

Update users

PUT changes to all users matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
required
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "an username",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Insert new users

POST a new user entity and save it to the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
required
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "an username",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Partial update an user

PATCH changes into the user matching the provided query parameters.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Request Body schema: application/json
required
name
string

A unique name that the user logs in with.

object (Person)

Personal information about an individual.

role
string

The name of the role this user has.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "person": {
    },
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

Delete users

DELETE users matching the provided query parameters, from the data store.

Authorizations:
AuthorizedRequest
query Parameters
name
string

The exact name of the user. Case sensitive.

nameLike
string

A portion of the user's name. Case insensitive.

emailLike
string

A portion of the user's email address. Case insensitive.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "detailMessage": "string",
  • "canRetry": true
}

user-roles

List all user roles

GET every user role available.

Authorizations:
AuthorizedRequest

Responses

Response samples

Content type
application/json
[
  • {
    }
]