Listado de pedidos de un comercio

GET 
/kidal/v1/Ordersfull/seller/:IDSELLER

Este endpoint permite obtener un listado completo de los pedidos de un comercio específico basado en el ID del vendedor proporcionado. Los pedidos en este listado son aquellos con pagos aprobados y están listos para ser enviados; sin embargo, pueden ser cancelados durante el proceso de envío, siempre y cuando el producto no cuente con guía.

Los parámetros de filtro opcionales incluyen el estado, el rango de fechas, el tamaño de página y la paginación para facilitar la búsqueda y el manejo de grandes volúmenes de pedidos. Ten en cuenta que los pedidos devueltos pueden tener diferentes estados y detalles, lo que te permite gestionar eficazmente tu inventario y las operaciones de envío.

Los parámetros disponibles para filtrar los pedidos son:

• filter-status-family: Filtra por la familia de estados de los pedidos.
• filter-date-range-end y filter-date-range-begin: Filtra por rango de fechas de los pedidos.
• filter-status: Filtra por un estado específico de los pedidos.
• pageSize y page: Controlan el tamaño de la página y la paginación para la respuesta.
• filter-orderId: Filtra por ID de pedido específico.

Para obtener más detalles sobre los parámetros y las respuestas posibles, consulta la sección de especificaciones correspondiente.

Nota: Es necesario proporcionar un token de autorización válido en la solicitud para acceder a este endpoint.

Request

Path Parameters

IDSELLER stringrequired

ID del vendedor

Query Parameters

filter-status-family string[]

Filtrar por familia de estado

filter-date-range-end date

Fecha de fin del rango

filter-date-range-begin date

Fecha de inicio del rango

filter-status string

Possible values: [por enviar, por recolectar, En camino, Entregado, Facturado, cancelado por vendedor, cancelado por cliente]

Filtrar por estado

pageSize integer

Tamaño de la página

page integer

Número de la página

filter-orderId string

Filtrar por ID de orden

Responses

200

Respuesta exitosa

application/json

Schema

Schema

metadata

object

Metadatos sobre la respuesta

status string

Estado de la respuesta

message string

Mensaje de la respuesta

http_code integer

Código de estado HTTP

date_time date-time

Fecha y hora de la respuesta

data

object[]

Lista de pedidos

Array [

id string

Identificador único del pedido

orderid string

ID de la orden en el marketPlace

marketplace string

Possible values: [CS, SR, SN]

Identificador del marketPlace

sellerID string

ID del vendedor

external_id stringnullable

ID externo

purchase_date date-time

Fecha y hora de compra

authorization_date date-time

Fecha y hora de autorización

paymentData

object

Datos de pago, información no disponible por API para 3ros.

status stringnullable

Estado del pago, información no disponible por API para 3ros.

plan stringnullable

Plan de pago, información no disponible por API para 3ros.

paymentMetod stringnullable

Método de pago, información no disponible por API para 3ros.

paymentDueDate datenullable

Fecha de vencimiento del pago, información no disponible por API para 3ros.

paymentReference stringnullable

Referencia de pago, información no disponible por API para 3ros.

bank string

Nombre del banco, información no disponible por API para 3ros.

binCard stringnullable

Número de identificación bancaria (BIN) de la tarjeta, información no disponible por API para 3ros.

cardLastDigits stringnullable

Últimos dígitos de la tarjeta, información no disponible por API para 3ros.

cardType stringnullable

Tipo de tarjeta (e.g., Visa, MasterCard), información no disponible por API para 3ros.

bankAffiliation string

Afiliación bancaria, información no disponible por API para 3ros.

paymentNoInstallments integer

Número de cuotas, información no disponible por API para 3ros.

paymentInstallments stringnullable

Cuotas de pago, información no disponible por API para 3ros.

subtotal float

Subtotal

discount stringnullable

Descuento aplicado, información no disponible por API para 3ros.

couponAmount stringnullable

Monto del cupón aplicado, información no disponible por API para 3ros.

shippingCosts float

Costos de envío

total float

Total

commissions stringnullable

Comisiones aplicadas, información no disponible por API para 3ros.

shippingAddress

object

Dirección de envío

zipCode string

Código postal

city string

Ciudad

phoneNumber string

Número de teléfono

notes string

Notas sobre la dirección

outdoorNumber string

Número exterior

interiorNumber string

Número interior

borough string

Delegación

betweenStreets string

Entre calles

suburb string

Colonia

stateCode stringnullable

Código del estado

state string

Estado

street string

Calle

addressee string

Destinatario

clientData

object

Datos del cliente

id string

ID del cliente

fullname string

Nombre completo del cliente

email string

Correo electrónico del cliente

orderedProductsList

object[]

Lista de productos ordenados

Array [

colocationId string

ID de colocación, (Partida)

idProduct string

ID de la publicación en el marketPlace

name string

Nombre del producto

sku string

SKU del producto

universal_id stringnullable

ID universal

saleDiscount float

Descuento de venta

totalSale float

Venta total

colocationStatus

object

Estado de la partida.

id string

Possible values: [1, 2, 3, 4, 5, 6, 7]

ID del estado

name string

Nombre del estado - por enviar - por recolectar - En camino - Entregado - Facturado - cancelado por cliente - cancelado por vendedor

reasonID stringnullable

ID de la razón

reasonName stringnullable

Nombre de la razón

deliveryTrackId string

ID de seguimiento de entrega, ( Número de guía)

deliveryCarrierId string

ID del transportista

deliveryCarrierName string

Nombre del transportista

deliveryType string

Possible values: [dropshipping, fulfillment]

Tipo de entrega

productType string

Tipo de producto

dimensions

object[]

Dimensiones del producto

Array [

height float

Altura del producto

width float

Ancho del producto

depth float

Profundidad del producto

weight float

Peso del producto

]

idFulfillment string

ID Fulfillment

imageLinkThumbnail string

Enlace a la imagen en miniatura del producto

clickAndCollect stringnullable

Información de click and collect

statusInvoice string

Estado de la factura

]

]

pagination

object

Información de paginación

total_registros integer

Número total de registros

total_count integer

Número total de elementos en la página actual

page integer

Número de la página actual

page_size integer

Tamaño de la página

Example (from schema)

{
  "metadata": {
    "status": "success",
    "message": "OK",
    "http_code": 200,
    "date_time": "2024-06-08T05:35:59.515+00:00"
  },
  "data": [
    {
      "id": "f976e8e4cae393af65251a81805ad3de",
      "orderid": 83783474,
      "marketplace": "SR",
      "sellerID": 10541,
      "external_id": null,
      "purchase_date": "2024-05-24T12:09:48.000+00:00",
      "authorization_date": "2024-05-24T12:17:18.000+00:00",
      "paymentData": {
        "status": null,
        "plan": null,
        "paymentMetod": null,
        "paymentDueDate": null,
        "paymentReference": null,
        "bank": "",
        "binCard": null,
        "cardLastDigits": null,
        "cardType": null,
        "bankAffiliation": "",
        "paymentNoInstallments": 1,
        "paymentInstallments": null,
        "subtotal": 350,
        "discount": null,
        "couponAmount": null,
        "shippingCosts": 82,
        "total": 432,
        "commissions": null
      },
      "shippingAddress": {
        "zipCode": 15670,
        "city": "Venustiano Carranza",
        "phoneNumber": 5579797979,
        "notes": "",
        "outdoorNumber": 13,
        "interiorNumber": "INT 1",
        "borough": "Venustiano Carranza",
        "betweenStreets": "Calle 1 y Calle 2",
        "suburb": "Adolfo López Mateos",
        "stateCode": null,
        "state": "Ciudad de México",
        "street": "Calle Entrega",
        "addressee": "Jaime Fulanito"
      },
      "clientData": {
        "id": 1106754,
        "fullname": "Jaime Flulainito",
        "email": "correo_cliente@hotmail.com"
      },
      "orderedProductsList": [
        {
          "colocationId": 12491524,
          "idProduct": 2948290,
          "name": "Producto de prueba Mongo",
          "sku": "SKUP_V1",
          "universal_id": null,
          "saleDiscount": 0,
          "totalSale": 350,
          "colocationStatus": {
            "id": 5,
            "name": "facturado",
            "reasonID": null,
            "reasonName": null
          },
          "deliveryTrackId": 258746698885,
          "deliveryCarrierId": 13,
          "deliveryCarrierName": "Manual",
          "deliveryType": "dropshipping",
          "productType": "physicals",
          "dimensions": [
            {
              "height": 1,
              "width": 1,
              "depth": 1,
              "weight": 1
            }
          ],
          "idFulfillment": 0,
          "imageLinkThumbnail": "https://resources.claroshop.com/medios-plazavip/t1/1715320187ImagendeWhatsApp20240417alas11461309c23dcdjpg",
          "clickAndCollect": null,
          "statusInvoice": "invoiced"
        }
      ]
    }
  ],
  "pagination": {
    "total_registros": 51,
    "total_count": 2,
    "page": 1,
    "page_size": 2
  }
}

Loading...