Package

This refers to the physical information of the unique consolidated package that will be integrated and consequently delivered. It includes information about its contents, dimensions, weight, value, etc. It's possible to specify the items that make up the package with information compatible with the "Carta Porte" document, as used in Mexico.

Fields

Package

Field	Data type	Required	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

Field	Data type	Required	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

Field description

packageType

Package Type.

Possible values:

packageType
UNIT
BOX
ENVELOPE
BAG
BUNDLE
PALLET
DUMMY

Defaults:

Value as default:

  UNIT

Example:

  BOX

Notes:

Providing the package type allows for the automatic selection of the optimal vehicle for package delivery. Not providing this field could potentially lead to the selection of incorrect vehicles and result in delivery delays.

description

Description of the package content.

Example:

  Sobre con documentos

contentValue

Declared value of the package in the unit provided in valueCurrency.

Example:

  200

valueCurrency

Currency unit corresponding to the contentValue field.

References:

• Currency codes
• Isp currency

Example:

  MXN

weight

Package weight provided in the weightUnit unit.

Example:

  9.8

weightUnit

Unit of measurement for the weight value provided in the weight field. Possible values are: grams, kilograms, ounces, pounds, and tons.

Possible values:

weightUnit
G
KG
OZ
LB
T

Example:

  KG

length

Length of the package according to the dimensionsUnit unit.

Example:

  40.0

width

Width of the package according to the dimensionsUnit unit.

Example:

  40.0

height

Height of the package according to the dimensionsUnit unit.

Example:

  40.0

dimensionsUnit

Unit of measurement for the provided weight value in the weight field. The possible values are millimeters, centimeters, meters, inches, and feet.

Possible values:

dimensionsUnit
CM
M
IN

Example:

  CM

items

An array of Item objects that describes the items contained within the consolidated package (the package).

Example:

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

Item

Description of the item being transported under the guidelines of the Carta Porte. The description of the fields used for Mexico can be obtained from the reference. The "units" field indicates the quantity of units of the same type consolidated in the package.

References:

• Cartaporte

Example:

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

Examples

Example in JSON format that makes use of all the fields

{
  "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"
    }
  ]
}

Example in JSON format that makes use of only the required fields

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