Crear Guía
https://api.bioderma.clicksend.com.mx/api/v1/createLabel
Método: POST
Objetivo del método:
El servicio recibe una orden para crear una guía de la paqueteria asignada en el key Carrier, para generar la guía es importante que la orden cuente con los valores en las Keys Customer, Packages, Shipping address.
Headers
Accept
Content-Type
Authorization
application/json
application/json
Bearer {ACCESS_TOKEN}
Body RAW
Request:
Campo | Tipo | Descripción |
---|---|---|
id * | String | ID pedido |
created_at | Timestamp | Fecha creación del pedido |
cancelled_at | Timestamp | Fecha cancelación del pedido |
financial_status | String | Estatus pago del pedido |
payment_gateway | String | Metodo de pago |
order_number | String | Número de pedido |
total_price | Number | Total del pedido |
total_discounts | String | Total con descuento |
[customer] id | String | ID cliente |
[customer] email | String | Email cliente |
[customer] first_name | String | Nombre cliente |
[customer] last_name | String | Apellidos cliente |
[customer] phone | String | Teléfono cliente |
[customer] currency | String | Tipo moneda cliente |
[shipping_address] first_name | String | Nombre cliente, dirección pedido |
[shipping_address] last_name | String | Apellidos cliente, dirección pedido |
[shipping_address] phone | String | Teléfono cliente, dirección pedido |
[shipping_address] city | String | Ciudad, dirección del pedido |
[shipping_address] zip | String | Código postal, dirección del pedido |
[shipping_address] province | String | Provincia, dirección pedido |
[shipping_address] country | String | País, dirección pedido |
[shipping_address] address1 | String | Dirección del pedido, limite 46 caracteres |
[shipping_address] address2 | String | Dirección del pedido, limite 46 caracteres |
[shipping_address] asent_address | String | Colonia o asentamiento, dirección del pedido |
[shipping_address] reference | String | Referencia, dirección del pedido |
[shipping_address] latitude | String | Latitude, dirección pedido |
[shipping_address] longitude | String | Longitud, dirección pedido |
[shipping_address] country_code | String | Código país, dirección pedido |
[shipping_address] province_code | String | Código provincia, dirección pedido |
[line_items] product_id | String | ID producto |
[line_items] grams | Number | Peso en gramos del producto |
[line_items] title | String | Nombre del producto |
[line_items] price | Number | Precio del producto |
[line_items] quantity | integer | Cantidad del producto |
[line_items] sku | String | SKU del producto |
[packages] weight | Number | Peso del pedido, min:0.001, max:999999999999 |
[packages] height | Number | Altura caja pedido, min:1, max:9999999 |
[packages] width | Number | Ancho caja pedido, min:1, max:9999999 |
[packages] length | Number | Largo de la caja pedido, min:1, max:9999999 |
[carrier] name_carrier | String | Nombre de la paquetería que se requiere crear la guía |
[carrier] price_carrier | Number | Precio envío |
[carrier] product_code | String | DHL Express Local código producto, por default: N (si la paquetería no es DHL, se puede enviar NULL) |
[carrier] plannedShippingDate | Timestamp | Fecha y hora en que se presenta el paquete. Se espera que se usen las partes de fecha y hora de la cadena. La fecha no debe ser una fecha pasada o una fecha de más de 10 días. |
Response:
201 OK
Campo | Tipo | Descripción |
---|---|---|
status_shipment | string | Estatus respuesta de lo ocurrido request |
carrier | String | Nombre de la paquetería |
shipment_number | String | Número de guía |
tracking_url | String | Url rastreo de la guía |
document_pdf | String | Base64 PDF |
message | String | Mensaje de éxito |
Errores de validación, se requiere token para petición
401 Error
Campo | Tipo | Descripción |
---|---|---|
error | string | Nombre del campo y mensaje, obligatorio en el request |
code | String | Código de error en el request |