Obtén los métodos de envío según la dirección y los parámetros del paquete.
Devuelve la lista de métodos de devolución para un socio determinado con parámetros adicionales como la disponibilidad.
POST /v1/shipping-methods/quote
Ejemplo de solicitud
{ "orderReferenceId": "EXMPL0001234", "currency": "EUR", "options": { "weightUnit": "g", "dimensionUnit": "mm", "label": { "format": "pdf" } }, "partner": { "clientName": "ExampleCustomer" }, "receiver": { "person": { "firstName": "Foo", "lastName": "Bar", "company": "", "email": "[email protected]", "phone": "01273552886" }, "address": { "country": "GB", "state": "East Sussex", "city": "Brighton", "postcode": "BN1 8YQ", "addressLine1": "11 London Rd", "addressLine2": "", "addressLine3": "", "street": "London Rd", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": null } }, "sender": { "person": { "firstName": "", "lastName": "", "company": "Example Company", "email": "[email protected]", "phone": "01666 123456" }, "address": { "country": "DE", "state": "", "city": "Donauwörth", "postcode": "86609", "addressLine1": "Am Wassergraben 11", "addressLine2": null, "addressLine3": null, "street": "Am Wassergraben", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": "DE123456789000", "iossNumber": null, "eoriNumber": "GB987654321000", "pcccNumber": null, "australianBusinessNumber": null } }, "packages": [ { "packageReferenceId": "EXMPL0001234-0-1", "grossWeight": 810, "netWeight": 760, "length": 229, "width": 200, "height": 36, "boxType": "rectangle", "volumetricWeight": 700, "items": [ { "itemReferenceId": "EXMPL0001234-0-1-ITEM1", "description": "Mug", "value": 48, "quantity": 4, "weight": 760, "hsCode": "44199090", "countryOfOrigin": "DE" } ] } ]}Ejemplo de respuesta de éxito
{ "items": [ { "carrier": { "name": "DHL", "uid": "dhl" }, "method": { "name": "DHL Global Parcel", "uid": "dhl_global_parcel", "price": 3.32, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } }, { "carrier": { "name": "UPS", "uid": "ups" }, "method": { "name": "UPS Standard Tariff", "uid": "ups_standard_tariff", "price": 5.25, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } } ], "count": 2}Ejemplo de respuesta de error
{ "orderReferenceId": "EXMPL0001234", "code": "VALIDATION_ERROR", "message": "There are errors in submitted data", "errors": [ { "code": "NO_SUCH_CHOICE_ERROR", "reference": "options.label.format", "message": "The value you selected is not a valid choice." }, { "code": "IS_BLANK_ERROR", "reference": "receiver.address.country", "message": "This value should not be blank." } ]}Solicitar
Parámetro | Tipo | Descripción |
orderReferenceId (obligatorio) | cadena | Identificador único para el pedido de envío. Identificador proporcionada por ti. |
moneda (obligatorio) | cadena | Moneda del pedido de envío en formato de 3 letras. |
Opciones (opcional) | Opciones | Parámetros opcionales. |
Socio (opcional) | Compañero | Detalles del socio. |
receptor (obligatorio) | Receptor | Detalles del destinatario. |
Remitente (obligatorio) | Remitente | Detalles del remitente. |
paquetes (obligatorio) | Paquete[] | Detalles del paquete. |
Opciones
Parámetro | Tipo | Descripción |
weightUnit (opcional) | cadena | Unidad de peso. Opciones disponibles: g, kg, oz, lb. Por defecto: g. |
dimensionUnit (opcional) | cadena | Unidad de longitud. Opciones disponibles: mm, cm, in. Por defecto: mm. |
Etiqueta (opcional) | Etiqueta | Configuración del formato de la etiqueta. |
Etiqueta
Parámetro | Tipo | Descripción |
formato (opcional) | cadena | Formato de etiqueta. Opciones disponibles: pdf, zpl (*). Por defecto: pdf. |
Nota: Es posible que algunos transportistas no admitan formatos que no sean PDF.
Compañero
Parámetro | Tipo | Descripción |
Nombre del cliente (opcional) | cadena | Envío del perfil del cliente. |
Receptor
Parámetro | Tipo | Descripción |
persona (obligatorio) | ReceiverPerson | Datos personales del destinatario. |
dirección (obligatorio) | Dirección | Detalles de la dirección del destinatario. |
Aduanas (opcional) | Aduanas del destinatario | Detalles de aduanas del destinatario. |
Remitente
Parámetro | Tipo | Descripción |
persona (obligatorio) | RemitentePersona | Detalles personales del remitente. |
dirección (obligatorio) | Dirección | Detalles de la dirección del remitente. |
Aduanas (requerido para envíos internacionales) | Aduanas del remitente | Detalles de aduanas del remitente. |
ReceiverPerson
Parámetro | Tipo | Descripción |
Nombre (obligatorio) | cadena | Nombre de pila de la persona receptora. |
Apellido (obligatorio) | cadena | Apellido de la persona receptora. |
empresa (opcional) | cadena | El título de la empresa. |
correo electrónico (opcional*) | cadena | Dirección de correo electrónico de la persona. Se puede utilizar para notificaciones de envío. |
Teléfono (opcional*) | cadena | Número de teléfono de la persona. Se puede utilizar para notificaciones de envío. |
Nota: *El correo electrónico y el teléfono pueden ser campos obligatorios en función de la empresa de transporte.
SenderPerson
Parámetro | Tipo | Descripción |
Nombre (opcional) | cadena | Nombre de pila de la persona remitente. |
Apellido (opcional) | cadena | Apellido de la persona remitente. |
empresa (obligatorio) | cadena | El título de la empresa remitente. |
Correo electrónico (opcional*) | cadena | Dirección de correo electrónico de la persona o empresa remitente. |
Teléfono (opcional*) | cadena | Número de teléfono de la persona o empresa remitente. |
Nota: *El correo electrónico y el teléfono pueden ser campos obligatorios según la empresa de transporte
Dirección
Parámetro | Tipo | Descripción |
país (obligatorio) | cadena | Código de país en formato de 2 letras. |
Estado (opcional*) | cadena | Estado/condado/región. |
ciudad (obligatorio) | cadena | Ciudad. |
Código postal (obligatorio) | cadena | Código postal. |
Dirección línea 1 (obligatorio) | cadena | Primera línea de la dirección postal. Debe incluir la calle y el número de la casa. |
Dirección línea 2 (opcional) | cadena | Segunda línea de la dirección postal. Número de apartamento/oficina/piso. |
Dirección línea 3 (opcional) | cadena | Tercera línea de la dirección postal. |
calle (opcional*) | cadena | Calle (obligatorio para direcciones de Alemania). |
Número de casa (opcional*) | cadena | Número de casa (obligatorio para direcciones de Alemania). |
Suburbio (opcional*) | cadena | Suburb (obligatorio para direcciones de AU/NZ). |
Nota: *Estos campos opcionales son obligatorios para determinados países y transportistas.
Aduanas del destinatario
Parámetro | Tipo | Descripción |
Número de IVA (opcional) | cadena | Número de IVA del receptor. |
Aduanas del remitente
Parámetro | Tipo | Descripción |
Número de IVA (opcional*) | cadena | Número de IVA del remitente. |
Número IOSS (opcional*) | cadena | Número IOSS del remitente. |
Número EORI (opcional*) | cadena | Número EORI del remitente. |
pcccNumber (opcional*) | cadena | Número PCCC del remitente. |
australianBusinessNumber (opcional*) | cadena | Número de empresa australiano del remitente. |
Nota: *Dependiendo del país del remitente y del destinatario, estos campos pueden ser obligatorios.
Paquete
Parámetro | Tipo | Descripción |
packageReferenceId (obligatorio) | cadena | Identificador del paquete proporcionado por el socio. |
Peso bruto (obligatorio) | número | Peso del embalaje + peso de los artículos (en gramos por defecto). |
netWeight (opcional) | número | Peso de los artículos (en gramos de forma predeterminada). |
Longitud (obligatorio) | número | Longitud del paquete (en mm por defecto). |
Ancho (obligatorio) | número | Ancho del paquete (en mm por defecto). |
altura (obligatorio) | número | Altura del paquete (en mm por defecto). |
volumetricWeight (opcional) | número | Peso calculado en función del tamaño del paquete (en gramos de forma predeterminada). |
Tipo de caja (opcional) | cadena | Forma de la caja (por ejemplo, rectángulo, tubo). |
valor (obligatorio para envíos internacionales) | número | Valor total de todos los artículos del paquete (en la divisa seleccionada). |
artículos (obligatorio para envíos internacionales) | Artículo[] | Lista de artículos del paquete. |
Artículo*
Parámetro | Tipo | Descripción |
itemReferenceId (obligatorio) | cadena | Identificador del artículo del paquete proporcionado por el socio. |
Descripción (obligatorio) | cadena | Descripción del artículo. |
Cantidad (obligatorio) | número | Cantidad del artículo. |
valor (obligatorio) | número | Valor del artículo (en la divisa seleccionada). |
peso (obligatorio) | número | Peso del artículo (en gramos por defecto). |
hsCode (obligatorio) | cadena | Código del Sistema Armonizado (Wiki). |
countryOfOrigin (obligatorio) | cadena | Código de país en formato de 2 letras donde se produjo el artículo. |
Nota: *Todos los parámetros del artículo solo son necesarios para el envío internacional.
Respuesta satisfactoria
Parámetro | Tipo | Descripción |
contar | número | Número de resultados encontrados. |
artículos | ResponseItems | Una matriz de los presupuestos |
ResponseItems
Parámetro | Tipo | Descripción |
transportista | ResponseItemsCarrier | Detalles del transportista. |
método | ResponseItemsMethod | Detalles del método de envío. |
ResponseItemsCarrier
Parámetro | Tipo | Descripción |
transportista | cadena | Transportista utilizado para el pedido. |
UID | cadena | Método de envío utilizado para el pedido. |
ResponseItemsMethod
Parámetro | Tipo | Descripción |
Nombre | cadena | Nombre del método de envío. |
uid | cadena | UID del método de envío. |
Precio | número | Precio estimado del método de envío para el socio. |
maxShipmentDays | número | Días máximos de envío del método de envío. |
minShipmentDays | número | Días mínimos de envío del método de envío. |
deliveryPaddingDays (opcional) | número | Días de margen de entrega del método de envío. |
Respuesta de error
Parámetro | Tipo | Descripción |
ID de referencia de pedido | cadena | Identificador único del pedido de envío proporcionado por ti. |
código | cadena | Código de error. |
mensaje | cadena | Mensaje de error. |
detalle (opcional) | objeto | Mensaje de error detallado (objeto JSON de una estructura arbitraria ). |
errores (opcional) | ResponseErrorDetails[] | Lista de errores. |
Detalles del error de respuesta
Parámetro | Tipo | Descripción |
código | cadena | Código de error. |
mensaje | cadena | Mensaje de error |
Referencia (opcional) | cadena | ID de referencia. |
Siguiente paso: 🔗[GCL] API de logística: seguimiento
📝 ¿No era esto lo que buscabas?
Ayúdanos a mejorar este artículo, envíanos un correo a [email protected] — por favor, incluye el título del artículo.