Shipment Detail

Detalle de embarque

Obtiene información de un embarque 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/shipments/(int: folio)/

Parámetros:

folio (int) – Folio del embarque.

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:

folio (int) – Folio del embarque.
reference_document (string) – Tipo de documento referenciado.
reference_folio (int) – Folio del documento referenciado.
reference_serie (string) – Serie del documento referenciado.
status (obj) – Estatus del documento.
created_at (string) – Fecha de creación del documento.
user (obj) – Usuario que creó el documento.
warehouse (obj) – Almacén asociado.
payment_method (string) – Documento de pago.
account (string) – Cuenta bancaria.
account_name (string) – Nombre de la cuenta bancaria.
expiration_date (string) – Fecha de expiración.
authorization_code (string) – Código de autorización.
user_authorization (obj) – Usuario que autorizó el documento.
authorization_date (string) – Fecha de autorización.
bank (obj) – Banco asociado.
deliveries (obj) – Entregas asociadas al documento.

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.

status object:

Objeto JSON de respuesta:

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

user object:

Objeto JSON de respuesta:

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

warehouse object:

Objeto JSON de respuesta:

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

user_authorization object:

Objeto JSON de respuesta:

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

bank object:

Objeto JSON de respuesta:

id (int) – Id del banco.
description (string) – Nombre del banco.

deliveries object:

Objeto JSON de respuesta:

id (int) – Id de la entrega.
delivery_batch (int) – Folio de lote.
status (obj) – Objeto con estatus de la entrga.
municipality (string) – Ciudad.
state (string) – Estado.
country (string) – País.

status object:

Objeto JSON de respuesta:

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

Example request

GET /v1/shipments/3671055/ 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

{
	"folio": 3671055,
	"reference_document": "FACTC",
	"reference_folio": 103452,
	"reference_serie": "X",
	"status": {
		"id": "CF",
		"description": "Confirmado"
	},
	"created_at": "2025-05-27T23:24:52.523000Z",
	"user": {
		"id": 1568,
		"username": "pedidbnrt"
	},
	"warehouse": {
		"id": 97,
		"name": "Certificados Digitales"
	},
	"payment_method": "COBXT",
	"account": "000000000000",
	"account_name": "BC**ABC*****",
	"expiration_date": "0000",
	"authorization_code": "",
	"user_authorization": {
		"id": 1568,
		"username": "pedidbnrt"
	},
	"authorization_date": "2025-05-27T23:24:54.523000Z",
	"bank": {
		"id": 1,
		"description": "SIN BANCO"
	},
	"deliveries": [
		{
			"id": 3947984,
			"delivery_batch": 0,
			"status": {
				"id": "CF",
				"description": "Confirmado"
			},
			"municipality": "ensenada",
			"state": "baja california",
			"country": "MEX"
		}
	]
}