Order Detail

Detalle del pedido

Obtiene información de un pedido en base al ID enviado.

Nombre

Tipo y longitud o rango de dato

Descripción

Requerido

Default

HOST

URL

Se indicará de acuerdo el ambiente

donde será consumido el servicio:

Producción:

https://api.next-cloud.mx

Staging:

https://stg-api.next-cloud.mx

Sí

N/A

Resource URL

GET HOST/v1/orders/(int: id)/

Parámetros:

id (int) – Identificador del pedido.

Encabezados de solicitud:

Authorization – Token del usuario.
Content-Type – Define el formato en el que se envian los datos por el body.

Objeto JSON de respuesta:

id (int) – Identificador del pedido.
document (string) – Clave del documento factura.
folio (int) – Folio de la factura.
serie (string) – Serie de factura.
customer (obj) – Objeto del cliente.
status (obj) – Objeto del estado.
warehouse (obj) – Objeto del almacén.
store (obj) – Objeto de la tienda.
total (float) – Total del pedido.
created_at (string) – Fecha de creación del documento.
user (obj) – Objeto del usuario.
agent (obj) – Objeto del agente.
shipment (int) – Folio del embarque.
reference_document (string) – Documento de referencia.
reference_folio (int) – Folio de referencia.
order_number (string) – Número de orden.
comments (string) – Comentarios.
channel (obj) – Objeto del canal.
amount (float) – Cantidad del pedido.
discount (float) – Descuento del pedido.
delivery_fee (float) – Tarifa entrega del pedido.
taxes (obj) – Objeto de impuestos.
items (array) – Artículos del pedido.
parent_order (int) – Folio del pedido padre.
order_numer2 (string) – Número de orden 2.

Códigos de Status:

200 OK – Ningún error.
400 Bad Request – Algún parámetro es incorrecto.
401 Unauthorized – Token no válido o no enviado.
404 Not Found – El embarque no existe.

customer object:

Objeto JSON de respuesta:

id (int) – Id del cliente.
name (string) – Razón social.

status object:

Objeto JSON de respuesta:

id (int) – Id del estado.
description (string) – Descripción del estado.

warehouse object:

Objeto JSON de respuesta:

id (int) – Id del almacén.
name (string) – Nombre del almacén.

store object:

Objeto JSON de respuesta:

id (int) – Id de la tienda.
description (string) – Descripción de la tienda.

user object:

Objeto JSON de respuesta:

id (int) – Id del usuario.
username (string) – Nombre de usuario.

agent object:

Objeto JSON de respuesta:

id (int) – Id de usuario.
username (string) – Nombre de usuario.

channel object:

Objeto JSON de respuesta:

id (int) – Id del canal.
description (string) – Descripción del canal.

taxes object:

Objeto JSON de respuesta:

iva (float) – Importe iva.
ieps (float) – Importe ieps.

items array:

Objeto JSON de respuesta:

product (obj) – Objeto artículo.
quantity (float) – Cantidad solicitada.
backorder (float) – Cantidad en backorder.
price (float) – Precio.
total (float) – Total.
tax_rate (float) – Impuesto.

product object:

Objeto JSON de respuesta:

sku (string) – SKU del artículo.
description (string) – Descripción del artículo.

Example request

GET /v1/orders/1043163/ HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Content-Type: application/json
Authorization: Token ( token del usuario )

Example Response

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET

{
    "id": 1043163,
    "document": "FACTC",
    "folio": 3982,
    "serie": "E",
    "customer": {
        "id": 1,
        "name": "PUBLICO GENERAL"
    },
    "status": {
        "id": "F ",
        "description": "Facturado"
    },
    "warehouse": {
        "id": 1,
        "name": "Mercado Libre Full Fillment"
    },
    "store": {
        "id": 80,
        "description": "FERRARI"
    },
    "total": "4060.00",
    "created_at": "2022-05-09T09:21:58.897000Z",
    "user": {
        "id": 520,
        "username": "fperez"
    },
    "agent": {
        "id": 520,
        "username": "fperez"
    },
    "shipment": 928436,
    "reference_document": "PEDID",
    "reference_folio": 1043163,
    "order_number": "",
    "comments": "",
    "channel": {
        "id": 0,
        "description": "Spring 2011"
    },
    "amount": "3500.00",
    "discount": "0.00",
    "delivery_fee": "0.00",
    "taxes": {
        "iva": "560.00",
        "ieps": "0.00"
    },
    "items": [
        {
            "product": {
                "sku": "AI-0193",
                "description": "CABLE IUSA NO. 8  (CAJA CON 100 METROS  C/U ) 2 NEGROS , 1 ROJO Y 1 BLANCO"
            },
            "quantity": "1.0000",
            "backorder": "0.0000",
            "price": "3500.0000",
            "total": "3500.0000",
            "tax_rate": "16.0000"
        }
    ],
    "parent_order": 0,
    "order_numer2": ""
}