Package

Corresponde a la información física del paquete consolidado único que será integrado y por consecuencia entregado. Incluye información de su contenido, dimensiones, peso, valor, etc. Es posible especificar los items que componen el paquete con información compatible para Carta Porte como es utilizada en México.

Campos

Package

Campo	Tipo de dato	Requerido	Default
packageType	ENUM	No	UNIT
description	String	No
contentValue	int	No
weight	float	No
weightUnit	String	No	G
length	float	No
width	float	No
height	float	No
dimensionsUnit	float	No	CM
items	List[Item]	No

Item

Campo	Tipo de dato	Requerido	Default
units	int	No
c_ClaveUnidadPeso	String	No
c_ClaveProdServCp	String	No
c_MaterialPeligroso	String	No
c_TipoEmbalaje	String	No
contentValue	String	No
valueCurrency	String	No

Descripción de los campos

packageType

Tipo de paquete.

Posibles valores:

packageType
UNIT
BOX
ENVELOPE
BAG
BUNDLE
PALLET
DUMMY

Valor por defecto:

  UNIT

Ejemplos:

  BOX

Notas:

Proporcionar el tipo de paquete permite seleccionar, de forma automática, el vehículo óptimo para la entrega del paquete. No proporcionar este campo puede potencialmente conllevar a la selección de vehículos equivocados y generar retrasos en las entregas.

description

Descripción del contenido del paquete.

Ejemplos:

  Sobre con documentos

contentValue

Valor declarado del paquete en la unidad provista en valueCurrency.

Ejemplos:

  200

valueCurrency

Unidad de moneda que corresponde al campo contentValue.

Referencias:

• Currency codes
• Isp currency

Ejemplos:

  MXN

weight

Peso del paquete proporcionado según la unidad weightUnit.

Ejemplos:

  9.8

weightUnit

Unidad de medida del valor de peso proporcionado en el campo weight. Los valores posibles son: gramos, kilogramos, onzas, libras y toneladas.

Posibles valores:

weightUnit
G
KG
OZ
LB
T

Ejemplos:

  KG

length

Longitud del paquete según la unidad dimensionsUnit.

Ejemplos:

  40.0

width

Ancho del paquete según la unidad dimensionsUnit.

Ejemplos:

  40.0

height

Altura del paquete según la unidad dimensionsUnit.

Ejemplos:

  40.0

dimensionsUnit

Unidad de medida del valor de peso proporcionado en el campo weight. Los valores posibles son: milímetros, centímetros, metros, pulgadas y pies.

Posibles valores:

dimensionsUnit
CM
M
IN

Ejemplos:

  CM

items

Arreglo (array) de Item, el cual describe los items contenidos en el paquete consolidado (el package).

Ejemplos:

[
  {
    "units": 1,
    "c_ClaveUnidadPeso": "M86",
    "c_ClaveProdServCp": "49241801",
    "c_MaterialPeligroso": "0005",
    "c_TipoEmbalaje": "1A1",
    "contentValue": 12.0,
    "valueCurrency": "MXN"
  }
]

Item

Descripción del item transportado bajo los lineamientos de la Carta Porte. La descripción de los campos utilizados para México se puede obtener de la referencia. El campo units indica la cantidad de unidades del mismo tipo consolidadas en el paquete.

Referencias:

• Cartaporte

Ejemplos:

{
  "units": 1,
  "c_ClaveUnidadPeso": "M86",
  "c_ClaveProdServCp": "49241801",
  "c_MaterialPeligroso": "0005",
  "c_TipoEmbalaje": "1A1",
  "contentValue": 12.0,
  "valueCurrency": "MXN"
}

Ejemplos

Ejemplo en formato JSON que hace uso de todos los campos

{
  "packageType": "BOX",
  "description": "string",
  "contentValue": 150,
  "valueCurrency": "MXN",
  "weight": 5.0,
  "weightUnit": "KG",
  "length": 40.0,
  "width": 40.0,
  "height": 40.0,
  "dimensionsUnit": "CM",
  "items": [
    {
      "units": 1,
      "c_ClaveUnidadPeso": "M86",
      "c_ClaveProdServCp": "49241801",
      "c_MaterialPeligroso": "0005",
      "c_TipoEmbalaje": "1A1",
      "contentValue": 12.0,
      "valueCurrency": "MXN"
    }
  ]
}

Ejemplo en formato JSON que hace uso solo de los campos requeridos

{
  "weight": 1.0,
  "weightUnit": "KG",
  "length": 1.0,
  "width": 1.0,
  "height": 1.0,
  "dimensionsUnit": "CM"
}