Crear Orden

            
              https://crocs.clicksend.com.mx/api/v2/createOrder

Método: POST

Objetivo del método:

Este servicio web recibe por medio de webhook el payload de la orden cuando una orden es pagada, para generar la guía es importante que la orden cuente con los valores en las Keys Customer, Line Items, Shipping address y Shipping Lines.

Para generar la guía de la orden el sistema toma el valor que se encuentra en Shipping Lines - Code que se encuentra relacionado a la paquetería que el cliente selecciono en el checkout, el sistem obtiene el valor y por medio de line items se obtiene los productos para generar el peso volumetrico del pedido y generar la guía con su PDF para poderlo imprimir e ingresar al paquete de la orden.

La orden se almacena en el CRM Ontraport guardando los datos del cliente, dirección y guía generada de la orden y procesando la orden en una automatización para notificar al cliente por medio de emails cuando la orden es pagada, procesada y recolectada

Headers

Accept

Content-Type

Authorization

application/json

application/json

Body RAW

Request:

Campo Tipo Descripción
id * String ID Orden
created_at Timestamp Fecha creación del pedido
cancelled_at Timestamp Fecha cancelación de la orden
financial_status String Estatus pago de la orden
payment_gateway_names Array Metodo de pago
name String Número de la orden
total_price Number Total de la orden
subtotal_price Number subtotal de la orden
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 de la orden
[shipping_address] zip String Código postal, dirección de la orden
[shipping_address] province String Provincia, dirección la orden
[shipping_address] country String País, dirección de la orden
[shipping_address] address1 String Dirección de la orden, limite 46 caracteres
[shipping_address] address2 String Dirección de la orden, limite 46 caracteres
[shipping_address] company String Colonia o asentamiento (parametro que se ocupa para solicitar la colonia en el chekout de la orden), dirección de la orden
[shipping_address] latitude String Coordenadas latitud de la orden
[shipping_address] longitude String Coordenadas longitud, dirección la orden
[shipping_address] country_code String Código país, dirección de la orden
[shipping_address] province_code String Código provincia, dirección de la orden
[line_items] 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
[shipping_lines] id String ID shipping lines
[shipping_lines] title String Nombre de la paquetería selecciona en la orden
[shipping_lines] code String Codigo de la paquetería selecciona en la orden
[shipping_lines] price Number Precio envío

Response:

201 OK
Campo Tipo Descripción
status_order string Estatus respuesta de lo ocurrido request
num_order String Número de la orden
shipment_number String Número de guía
tracking_url String Url rastreo de la guía
url_pdf String Url PDF de la guía
message String Mensaje de éxito

Error cuando ya existe una orden registrada

401 Error
Campo Tipo Descripción
status_order string Estatus respuesta de lo ocurrido request
num_order String Número de la orden
message String Mensaje de éxito