Carta Porte API Developer Guide ES
Carta Porte API Developer Guide ES
Guía de Desarrollo
Customer Technology
Marzo 2023
Guía de Desarrollo de API de FedEx Carta Porte Enabler
Tabla de contenido
Acerca de este documento ........................................................................................................................... 2
Organización ................................................................................................................................................. 2
Audiencia ...................................................................................................................................................... 2
1. Introducción a la API de FedEx Carta Porte Enabler (CARE) ................................................................. 3
1.1. Directrices HTTPS de la API Carta Porte Enabler (CARE)............................................................... 3
1.1.1. Encabezados HTTPS .............................................................................................................. 3
1.1.2. Métodos HTTPS ..................................................................................................................... 4
1.2. EndPoints para API de Carta Porte Enabler (CARE) ...................................................................... 6
1.3. Carta Porte Enabler (CARE) API JSON SCHEMA (SINGLE AWB) ..................................................... 7
1.4. Carta Porte Enabler (CARE) API JSON SCHEMA (BULK AWB) ...................................................... 10
1.5. CARE JSON Detalles ..................................................................................................................... 14
1.6. CARE API y manejo de errores .................................................................................................... 17
Tabla de Referencias ............................................................................................................................... 18
Organización
La Guía para desarrolladores de la API de FedEx Carta Porte (CARE) contiene información sobre los
detalles de RESTful para el desarrollo de su software local y describe los fundamentos de la creación de
llamadas https RESTful mediante cadenas JSON. Puede encontrar la información básica sobre las
transacciones, incluidos los campos que puede usar cuando desee enviar información adicional para el
complemento carta porte. Esta guía proporciona información de campo detallada y de alto nivel para
desarrollar llamadas REST.
Audiencia
La audiencia de esta guía es un desarrollador, un programador de software, un arquitecto de
aplicaciones o cualquier usuario que desee comprender cómo escribir código de transacción RESTful
utilizando su propio lenguaje de programación para implementar soluciones que respalden el requisito
de Carta Porte de las operaciones en México.
Los siguientes campos de encabezado son estándar para todas las respuestas REST:
Tabla 2. Encabezado de respuesta HTTPS POST de Carta Porte API.
El método HTTPS POST se puede usar para instanciar una nueva instancia de un recurso dentro
de una colección. En este caso, para crear una nueva instancia, se deben proporcionar todos los
elementos de datos requeridos.
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "NO",
"cveMaterialPeligroso": "",
"embalaje": "",
"fraccionArancelaria": "",
"uuidComercioExt": ""
},
{
"bienesTransp": "26111711",
"descripcion": "BATERÍA DE LITIO",
"cantidad": 10,
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "SI",
"cveMaterialPeligroso": "M1950",
"embalaje": "5H1",
"fraccionArancelaria": "",
"uuidComercioExt": ""
}
]
}
}
}
Una creación de recursos exitosa devolverá un código 200. Consulte la sección Respuesta y
manejo de errores a continuación para obtener más información.
Proces
URL Ambiente
o
https://ws.fedex.com/LAC/ServicesAPI/mx/cartaporte/customers AWB PRODUCCIÓ
simple N
https://wsbeta.fedex.com/LAC/ServicesAPI/mx/cartaporte/customers AWB
PRUEBAS
simple
Hasta
https://ws.fedex.com/LAC/ServicesAPI/mx/cartaporte/customersBulk PRODUCCIÓ
100
N
AWB#
https://wsbeta.fedex.com/LAC/ServicesAPI/mx/cartaporte/customersBu
Hasta
lk
100 PRUEBA
AWB#
1.3. Carta Porte Enabler (CARE) API JSON SCHEMA (SINGLE AWB)
El siguiente esquema resume la estructura JSON para una llamada AWB única. Nota: para obtener
detalles sobre variables, valores y reglas, consulte los detalles de CARE JSON apartado de este
documento.
Número de código
RFC
Origen TAX ID #
Número de rastreo
País de Residencia
Fiscal
Ubicaciones Ubicación […]
Número de código
RFC
Destino TAX ID #
Estructura
Descripción de la
Mercancia
Cantidad
Código de unidad
de medida
Peso en kilogramos
Número total de
productos Valor de la
Mercancias
mercancía
Producto […]
Divisa
Bandera Producto
Peligroso
Código Producto
Peligroso
Empaque de
Material Peligroso
Fracción
Arancelaria
UUID de comercio
exterior
},
{
"bienesTransp": "26111711",
"descripcion": "BATERÍA DE LITIO",
"cantidad": 10,
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "SI",
"cveMaterialPeligroso": "M1950",
"embalaje": "5H1",
"fraccionArancelaria": "",
"uuidComercioExt": ""
}
]
}
}
}
1.4. Carta Porte Enabler (CARE) API JSON SCHEMA (BULK AWB)
El siguiente esquema resume la estructura JSON para una llamada de múltiples AWB. Nota: para
obtener detalles sobre variables, valores y reglas, consulte los detalles de CARE JSON apartado de
este documento.
Número de código
RFC
Origen TAX ID #
Número de rastreo
País de Residencia
Fiscal
Ubicaciones Ubicación […]
Número de código
RFC
Estructura [...]
Destino TAX ID #
Descripción de la
Mercancia
Cantidad
Código de unidad
de medida
Peso en kilogramos
Número total de
productos Valor de la
Mercancias
mercancía
Producto […]
Divisa
Bandera Producto
Peligroso
Código Producto
Peligroso
Empaque de
Material Peligroso
Fracción Arancelaria
UUID de comercio
exterior
Figura 2. Múltiples esquemas AWB JSON, una matriz limitada a 100 elementos.
},
{
"bienesTransp": "26111711",
"descripcion": "BATERÍA DE LITIO",
"cantidad": 10,
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "SI",
"cveMaterialPeligroso": "M1950",
"embalaje": "5H1",
"fraccionArancelaria": "",
"uuidComercioExt": ""
}
]
}
},
{
"guia": "123456789102",
"ubicaciones": {
"ubicacion": [
{
"origen": {
"rfcRemitente": "XEXX010101000",
"numRegIdTrib": "1234567890",
"residenciaFiscal": "USA"
}
},
{
"destino": {
"rfcDestinatario": "XAXX010101000",
"numRegIdTrib": "",
"residenciaFiscal": "MEX"
}
}
]
},
"mercancias": {
"numTotalMercancias": 78,
"mercancia": [
{
"bienesTransp": "25172119",
"descripcion": "TELA DE BOLSA DE AIRE",
"cantidad": 56,
"claveUnidad": "H87",
"pesoEnKg": 19.000,
"valorMercancia": 400.00,
"moneda": "USD",
"materialPeligroso": "NO",
"cveMaterialPeligroso": "",
"embalaje": "",
"fraccionArancelaria": "",
"uuidComercioExt": ""
},
{
"bienesTransp": "25172118",
"descripcion": "REEMPLAZO DE BOLSA DE AIRE",
"cantidad": 12,
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "NO",
"cveMaterialPeligroso": "",
"embalaje": "",
"fraccionArancelaria": "",
"uuidComercioExt": ""
},
{
"bienesTransp": "26111711",
"descripcion": "BATERÍA DE LITIO",
"cantidad": 10,
"claveUnidad": "H87",
"pesoEnKg": 5.250,
"valorMercancia": 50.00,
"moneda": "USD",
"materialPeligroso": "SI",
"cveMaterialPeligroso": "M1950",
"embalaje": "5H1",
"fraccionArancelaria": "",
"uuidComercioExt": ""
}
]
}
}]
}
Los catalogos del SAT son publicados por el gobierno Mexicano en su sitio de internet
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/complemento_carta_porte.htm
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/CatalogosCartaPorte20.xls
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/c_FraccionArancelaria_01072022.
xls
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/catCFDI_V_4_14102022.xls
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/anexo_20_version3-3.htm
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/catalogos_emision_cfdi_complemento_ce.htm
Nota: Estos catálogos son responsabilidad del Servicio de Administración Tributaria de México ("SAT") y
están sujetos a cambios sin previo aviso o advertencia. FedEx no es responsable y no será responsable
de esta información o por cualquier uso de esta información por parte suya, y debe asegurarse de que
está trabajando con la última versión válida y vigente de los catálogos, así como de verificar
regularmente las actualizaciones en el sitio web del SAT.
Ejemplos de respuestas:
Tabla 6. Ejemplos de respuestas de la API de Carta Porte.
Tabla de Referencias