Filtrar pedidos

http

GET /orders?parameter-lookup=value HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?parameter-lookup=value" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'my-param-term': 'value'
})

php

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, " api_private_key");

$result = $aplazameClient->get("/orders", [
  "my-param-term" => "value",
]);

C#

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, " api_private_key");

dynamic result = client.Get("/orders?my-param-term=value");

info

Te puede interesar consultar la documentación general de filtros de la API.

Los tipos de búsquedas están explicados AQUÍ (string, choices, range, isnull y date).

Cantidad financiada exacta

http

GET /orders?total_amount=462000 HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?total_amount=462000" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'total_amount': 462000
})

php

$result = $aplazameClient->get("/orders", [
  "total_amount" => Aplazame\Serializer\Decimal::fromFloat(4620)->value,
]);

C#

dynamic result = client.Get($"/orders?total_amount=462000");

Confirmado después de

http

GET /orders?confirmed-gte=2015-12-22T15:09:30.537951Z HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?confirmed-gte=2015-12-22T15:09:30.537951Z" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'verified-isnull': True,
  'confirmed-isnull': False
})

php

$result = $aplazameClient->get("/orders", [
  "verified-isnull" => "yes",
  "confirmed-isnull" => "no",
]);

C#

dynamic result = client.Get($"/orders?confirmed-gte=2015-12-22T15:09:30.537951Z");

Verificado pero no confirmado

http

GET /orders?verified-isnull=yes&confirmed-isnull=no HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?verified-isnull=yes&confirmed-isnull=no" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'verified-isnull': True,
  'confirmed-isnull': False
})

php

$result = $aplazameClient->get("/orders", [
  "verified-isnull" => "yes",
  "confirmed-isnull" => "no",
]);

C#

dynamic result = client.Get($"/orders?verified-isnull=yes&confirmed-isnull=no");

Parámetro	Tipo	Requerido	Descripción
id	hash	string	ID del pedido en aplazame.
mid	string	string	ID del pedido.
total_amount	decimal	range	Importe del pedido.
discount	decimal	isnull, range	Cantidad del descuento del pedido.
discount_rate	decimal	isnull, range	Tasa de descuento en el precio del pedido.
created	ISO 8601	date, range	Fecha de creación del pedido.
verified	ISO 8601	isnull, date, range	Fecha que designa cuando se ha verificado el pedido.
confirmed	ISO 8601	isnull, date, range	Fecha que designa cuando se confirmó el pedido.
cancelled	ISO 8601	isnull, date, range	Fecha que designa cuando se canceló el pedido.

Pago inicial

http

GET /orders?instalment_plan-downpayment-state=failed HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?instalment_plan-downpayment-state=failed" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'instalment_plan-downpayment-state': ['failed']
})

php

$result = $aplazameClient->get("/orders", [
  "instalment_plan-downpayment-state" => ["failed"],
]);

C#

dynamic result = client.Get($"/orders?instalment_plan-downpayment-state=failed");

Parámetro	Tipo	Requerido	Descripción
instalment_plan-downpayment-state	string	choices	Estado del pago inicial.
instalment_plan-downpayment-amount	decimal	isnull, range	Importe del pago inicial.

Por teléfono

Número de teléfono del cliente exacto

http

GET /orders?customer-phone-number=612345678 HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?customer-phone-number=612345678" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'customer-phone-number': '612345678'
})

php

$result = $aplazameClient->get("/orders", [
  "customer-phone-number" => "612345678",
]);

C#

dynamic result = client.Get($"/orders?customer-phone-number=612345678");

Parámetro	Tipo	Requerido	Descripción
customer-id	hash	string	ID de cliente.
customer-phone-number	string	string	Teléfono móvil del cliente.
customer-phone-country	ISO 3166-1	string	Prefijo telefónico del país.
customer-created	ISO 8601	date, range	Fecha de creación.

Por documento de identificación del cliente

Tipo de documento de identificación; Las opciones son nif o nie.

http

GET /orders?customer-document_id-type=nif&customer-document_id-type=nie HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?customer-document_id-type=nif&customer-document_id-type=nie" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'customer-document_id-type': ['nif', 'nie']
})

php

$result = $aplazameClient->get("/orders", [
  "customer-phone-number" => ["nif", "nie"],
]);

C#

dynamic result = client.Get($"/orders?customer-document_id-type=nif&customer-document_id-type=nie");

Parámetro	Tipo	Requerido	Descripción
customer-document_id-number	string	string	Número de identificación del documento del cliente.
customer-document_id-country	ISO 3166-1	string	País emisor del documento de identificación del cliente.
customer-document_id-type	string	choices	Tipo de documento identificativo del cliente, los valores pueden ser nif, nie, cif, passport, others.

Por cuenta

Género exacto

http

GET /orders?account-type=existing&account-gender=0 HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?account-type=existing&account-gender=0" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'account-type': 'existing',
  'account-gender': 0
})

php

$result = $aplazameClient->get("/orders", [
  "account-type" => "existing",
  "account-gender" => 0,
]);

C#

dynamic result = client.Get($"/orders?account-type=existing&account-gender=0");

El último login no es null.

http

GET /orders?account-last_login-isnull=no HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

shell

$ curl "https://api.aplazame.com/orders?account-last_login-isnull=no" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

python

response = client.orders({
  'account-last_login-isnull': False
})

php

$result = $aplazameClient->get("/orders", [
  "account-last_login-isnull" => "no",
]);

C#

dynamic result = client.Get($"/orders?account-last_login-isnull=no");

Parámetro	Tipo	Requerido	Descripción
account-id	hash	string	ID del cliente.
account-type	string	choices	Tipo de cliente; las opciones son g invitado, n nuevo, e existente.
account-gender	integer	choices	Género; las opciones son 0 desconocido, 1 hombre, 2 mujer, 3 no aplica.
account-last_login	ISO 8601	isnull, date, range	Fecha del último inicio de sesión.
account-date_joined	ISO 8601	isnull, date, range	Fecha que designa cuando se creó la cuenta.