API docs by Redocly

pedidos t1 (1.0.0)

Download OpenAPI specification:Download

pedidos t1

Pedidos consulta

endpoint para obtnener las estadisticas de venta por sellerId

En este endpoint se obtendrán las estadisticas de venta del seller

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    },
  • "pagination": {
    }
}

endpoint para obtnener todas las ordenes de venta por sellerId

En este endpoint se obtendrán todas las ordenes de venta que correspondan con el seller proporcionado.

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

query Parameters
page
integer <int32> >= 1
Default: 1
Example: page=1

Página que se desea obtener.

pageSize
integer <int32> [ 1 .. 50 ]
Default: 20
Example: pageSize=20

Número de registros por página que se desea obtener.

object

filtra, por canal de ventas, en caso de no tener regresa todos, en caso de tener un filtro aplicado, regresa solo del(os) canal(es) de ventas en el flitro

order
string
Enum: "date-asc" "date-desc" "client-name-az" "client-name-za"

orden de los resultados * date-asc ordenado por fecha ascendente mas antiguos primero * date-desc ordenado por fecha descendente mas recientes primero * client-name-az por nombre del cliente en orden alfabetico * client-name-za por nombre del cliente en orden alfabetico inverso

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

endpoint para obtnener una colocacion especifica

este endpoint regresará el pedido correspondiente al pedido al que pertenece el id de colocación, dicho pedido contendrá la informacion relativa solo a los productos del seller seguirá las siguientes reglas:

  • si el producto correspondiente al id de colocación NO tiene una guia, se mostratran todos los productos del pedido que no tengan una guia y tengan el mismo metodo de entrega
  • si el producto correspondiente al id de colocación SI tiene una guia, se mostratran todos los productos del pedido que tengan la misma guia
Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

colocationId
required
string

Id dela colocación

marketplace
required
string

Marketplace al que corresponde la venta.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    }
}

endpoint para la cancelación de pedidos.

cancelación de pedidos

Authorizations:
applicationuser
Request Body schema: application/json

Pedido a cancelar

pedido
number
relationId
string
idtienda
number
reasonId
number
marketplace
string

Responses

Request samples

Content type
application/json
{
  • "pedido": 14876843,
  • "relationId": 83686224,
  • "idtienda": 125038,
  • "reasonId": 99,
  • "marketplace": "CS"
}

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

endpoint para obtnener todas las ordenes de venta por sellerId, (nueva versión)

En este endpoint se obtendrán todas las ordenes de venta que correspondan con el seller proporcionado.

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

query Parameters
page
integer <int32> >= 1
Default: 1
Example: page=1

Página que se desea obtener.

pageSize
integer <int32> [ 1 .. 50 ]
Default: 20
Example: pageSize=20

Número de registros por página que se desea obtener.

object

filtra, por canal de ventas, en caso de no tener regresa todos, en caso de tener un filtro aplicado, regresa solo del(os) canal(es) de ventas en el flitro

order
string
Enum: "date-asc" "date-desc" "client-name-az" "client-name-za"

orden de los resultados * date-asc ordenado por fecha ascendente mas antiguos primero * date-desc ordenado por fecha descendente mas recientes primero * client-name-az por nombre del cliente en orden alfabetico * client-name-za por nombre del cliente en orden alfabetico inverso

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

endpoint para obtnener las estadisticas de venta por sellerId, (nueva versión)

En este endpoint se obtendrán las estadisticas de venta del seller

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": {
    },
  • "pagination": {
    }
}

Pedidos Comandos

cambiar el status de un pedido

cambiar el status de un pedido, este endpoint solo sirve para pedidos que no tengan guia además cada marketplace tiene reglas para aceptar o rechazar los cambios

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

Request Body schema: application/json

status del pedido

status
string
Value: "cancel"
reason
string
Value: "sin_stock"

Responses

Request samples

Content type
application/json
{
  • "status": "cancel",
  • "reason": "sin_stock"
}

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

guias

agregar comentario al pedido

agrega un comentario al pedido

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

Request Body schema: application/json

arreglo de productos a crear

comment
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

endpoint para obtnener las guias de un pedido

endpoint para obtnener las guias de un pedido

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": [
    ]
}

crear guia

crear un guia para los productos listados (colocationID ) o para todo el pedido si no se listan productos

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

Request Body schema: application/json

arreglo de productos a crear

kind
string
Enum: "manual" "automatica"
carrier
string
Enum: "fedex" "dhl" "manual"
colocations
Array of strings
trackId
string

Solo es requerido y usado en caso de ser guia manual

Responses

Request samples

Content type
application/json
{
  • "kind": "manual",
  • "carrier": "fedex",
  • "colocations": [
    ],
  • "trackId": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

cambiar el status de una guia

cambiar el status de una guia y por ende de los productos y/o del pedido

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

deliveryTrackId
required
string

id de rastreo para el envio

Request Body schema: application/json

status de la guia y evidencia de entrega cuando el status es entregado

status
string
Enum: "iniciado" "transito" "incidencia" "entregado"
evidencia
string

archivo de evidencia codificado en base64 (jpeg,jpg,png,gif,bmp)

factura
string

Factura en formato xml codificado en base64

Responses

Request samples

Content type
application/json
{
  • "status": "iniciado",
  • "evidencia": "string",
  • "factura": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

endpoint para obtnener las anexos de una guia

endpoint para obtener la etiqueta del envio, este endpoint solo funciona para guias automaticas

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

deliveryTrackId
required
string

id de rastreo para el envio

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    }
}

factura

subir factura de un pedido

subir la factura de un pedido

Authorizations:
applicationuser
path Parameters
sellerId
required
string

Id del seller

orderId
required
string

Id de la orden de venta

marketplace
required
string

Marketplace al que corresponde la venta.

deliveryTrackId
required
string

id de rastreo para el envio

Request Body schema: multipart/form-data

factura en formato xml

mimetype
string
fileName
string
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    }
}