Observaciones

Algunos puntos importantes sobre la integración con ANYMARKET:

Límites

Sea amable. Si está enviando demasiadas solicitudes rápidamente, retornaremos un código de error 429 (too many requests). Tiene un límite de:

Encabezados de Control de Rate Limit

Al realizar llamadas a la API, los siguientes encabezados serán retornados para informar sobre los límites de solicitudes:

ratelimit-reset: Indica el tiempo restante (en segundos) para que el límite de solicitudes sea renovado y vuelva al máximo permitido por el endpoint.
ratelimit-limit: Define el límite máximo de solicitudes que el endpoint soporta dentro del período establecido.
ratelimit-remaining: Muestra el número de solicitudes restantes que pueden realizarse en el minuto actual. Este valor disminuye con cada solicitud realizada.

Estos encabezados ayudan a gestionar el uso de la API de forma eficiente y a evitar superar los límites establecidos.

Operaciones

Hacemos todo lo posible para que todas nuestras URLs sean RESTful. Cada URL puede soportar uno de los cuatro tipos distintos de verbos http:

GET obtiene información sobre un recurso
POST crea un recurso
PUT actualiza un recurso
DELETE elimina un recurso

Estructura

Paginación

La gran mayoría de las solicitudes que retornan una colección de recursos están paginadas. Por ejemplo, la consulta de categorías principales. Toda respuesta paginada se retorna en el siguiente formato:

{
  "links": [
    {
      "rel": "prev",
      "href": "https://sandbox-api.anymarket.com.br/v2/categories?offset=0"
    },
    {
      "rel": "next",
      "href": "https://sandbox-api.anymarket.com.br/v2/categories?offset=4"
    }
  ],
  "content": [
    ...
  ],
  "page": {
    "size": 2,
    "totalElements": 6,
    "totalPages": 3,
    "number": 1
  }
}

Para facilitar la navegación secuencial de los datos, disponibilizamos enlaces para ir a la página siguiente o regresar a la anterior.

Por defecto la consulta retorna 20 recursos por página. Sin embargo, permitimos que ese número se incremente hasta un máximo de 100. A continuación se presentan los parámetros que modifican la forma en que se retorna la página:

offset: Indica a partir de qué recurso comenzará la consulta. Para que la consulta comience desde la página inicial, el offset deberá tener el valor igual a 0.
limit: Indica la cantidad de recursos a retornar, desde 20 hasta un máximo de 100.
sort: Indica por qué atributo debe ordenarse la consulta

Fecha

Todo atributo que reciba una Fecha debe ser informado pasando la Zona Horaria.
Si el socio controla la Zona Horaria también deberá controlar el horario de verano, realizando los cambios necesarios.

Ejemplo:
08/03/2018 10:00:00 Zona Horaria GMT-3
Debe informarse de la siguiente forma 2018-03-08T10:00:00-03:00 Validación para las Fechas del Pedido:

La "FECHA DE CREACIÓN" (createdAt) del pedido no puede estar vacía.
La "FECHA DE EMISIÓN DE FACTURA" (date) Objeto[invoice] debe ser mayor o igual a la "FECHA DE CREACIÓN" (createdAt) del pedido.
La "FECHA DE EMISIÓN DE FACTURA" (date) Objeto[invoice] debe ser mayor que la "FECHA DE PAGO" (paymenteDate) del pedido.
La "FECHA DE PAGO" (paymenteDate) debe ser mayor que la "FECHA DE CREACIÓN" (createdAt) del pedido.
La "FECHA DE ENVÍO" (date) Objeto[tracking] debe ser mayor o igual a la "FECHA DE EMISIÓN DE FACTURA" (date) Objeto[invoice] del pedido.
La "FECHA DE ENVÍO" (date) Objeto[tracking] debe ser mayor que la "FECHA DE CREACIÓN" (createdAt) del pedido.
La "FECHA DE ENTREGA" (deliveredDate) Objeto[tracking] debe ser mayor o igual a la "FECHA DE ENVÍO" (date) Objeto[tracking] del pedido.
La "FECHA DE PREVISIÓN DE ENTREGA" (estimateDate) Objeto[tracking] debe ser mayor o igual a la "FECHA DE ENVÍO" (date) Objeto[tracking] del pedido.

Límites​

Encabezados de Control de Rate Limit​

Operaciones​

Estructura​

Paginación​

Fecha​