Listado de órdenes

Obtener listado de órdenes utilizando paginación y filtros opcionales.

Ejemplo de uso de filtros y paginación:

?sorts=name,-orderId // ordena ascendente por nombre, luego descendente por orderId

&paymentDateWithTzFormat>=2024-01-15,paymentDateWithTzFormat<=2024-02-15  // filtra según rango de fecha de pagos en formato con zona horaria

&page=1           // obtiene la primera página...

&pageSize=10      // ...que contiene 10 registros por página.

Nota:

  • Si no se especifica el parámetro de ordenamiento, se ordenará por defecto por orderId de forma descendente.

  • Si no se especifica el parámetro de paginación, se obtendran todos los registros.

Operadores de filtro

Operador Significado
== Equals
!= Not equals
> Greater than
< Less than
>= Greater than or equal to
<= Less than or equal to
@= Contains
_= Starts with
_-= Ends with
!@= Does not Contains
!_= Does not Starts with
!_-= Does not Ends with
@=* Case-insensitive string Contains
_=* Case-insensitive string Starts with
_-=* Case-insensitive string Ends with
==* Case-insensitive string Equals
!=* Case-insensitive string Not equals
!@=* Case-insensitive string does not Contains
!_=* Case-insensitive string does not Starts with

Campos disponibles para ordenar y filtrar

Propiedad Sort Filter
orderId true true
orderType true true
orderDate true true
name true true
paymentOption true true
paymentStatus true true
shipmentOption true true
shipmentStatus true true
total true true
salesChannel true true
createdDate true true
createdBy true true
locationId true true
orderStatus true true
buyerName true true
buyerEmail true true
buyerPhone true true
createdDateWithTzFormat true true
paymentDateWithTzFormat true true
paymentMethodLastDigits true true
cardBrand true true
productCount true true
locationName true true
hasPayout false false
store false false
storeId false false
currency false false
locale false false
countryName false false
currencySymbol false false
orderDetail false false
paymentAuthorizationCode false false
utmSource false false
apiKeyId false false
Request
Security:
BearerAuth
query Parameters
Filters
string or null
Sorts
string or null
Page
integer or null <int32> [ 1 .. 2147483647 ]
PageSize
integer or null <int32> [ 1 .. 2147483647 ]
Responses
200
get/Orders
Request samples
curl -i -X GET \
  'https://api.n1co.com/api/v2/Orders?Filters=string&Sorts=string&Page=1&PageSize=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "orders": [
    ],
  • "totalCount": 0
}
Copyright © n1co 2024. All right reserved.