Documentación

Crear información outbound

Este endpoint permite registrar en Yuju la información outbound de un pedido. Es útil para centralizar y asociar la información del sistema del vendedor con la del pedido generada por el marketplace.

Suggest Edits

📘

¿Tienes información importante de tu integración externa?

Por ejemplo, si estás obteniendo la información de la orden y creándola en otro sistema, puedes guardar en Yuju la información del otro sistema al que enviaste la información para mantener un control y feedback de las órdenes que ya se enviaron.

Esta información puede visualizarse en Yuju al final de los detalles de la orden.

Endpoint:

POST https://api.tp.yuju.io/orders/outbounds?id_channel=4301&id_order=50032

Parámetros de Consulta (Query Params):

CampoDescripciónRequerido
id_channelID del canal por el que se realiza el pedido✅
id_orderID del pedido✅

Cuerpo de la Solicitud (Request Body):

CampoDescripciónRequerido
statusEstado del pedido.✅
messageMensaje asociado al estado del pedido.✅
typeTipo de entidad (en este caso, "order").✅
referenceReferencia del pedido.✅
channel_idID del canal.✅
extraCampos adicionales personalizados.
- custom_fieldCampo personalizado adicional.
{
   "status": "created",
   "message": "creado con éxito",
   "type": "order",
   "module_name": "integracion default",
   "reference": "679982",
   "channel_id": 4301,
   "extra": {
       "custom_field": "text custom 2"
   },
   "actions": [
       {
           "message": "Reintento de creación",
           "params": {
               "id_order": "4358675859",
               "id_channel": 13,
               "id_shop": 1083336,
               "_url": "http://yuju.io/someurl",
               "_headers": {
                   "token": "....."
               }
           },
           "name": "request_http"
       }
   ]
}

Respuestas

Código 200

Cuando el pedido outbound se registra con éxito, el servidor responde con: 

{
   "module_name": "integracion default",
   "order_int_external_pk": "90bbb472-4177-4545-9141-8183b1cfc6d4",
   "updated_at": "2024-09-23T18:55:58.968371",
   "actions": [
       {
           "params": "{\"_url\": \"http://yuju.io/someurl\", \"id_shop\": 1083336, \"_headers\": {\"token\": \".....\"}, \"id_order\": \"4358675859\", \"id_channel\": 13}",
           "message": "Reintento de creación",
           "id": null,
           "id_channel": null,
           "result": null,
           "name": "request_http"
       }
   ],
   "id_channel": 4301,
   "id_order": "50032",
   "id_shop": 307,
   "extra": {
       "custom_field": "text custom 2"
   },
   "reference": "679982",
   "message": "creado con éxito",
   "status": "created",
   "type": "order",
   "created_at": "2024-09-23T18:55:58.968371"
}

📘

Nota

  • Es para hacer cualquier cambio a la información outbound es necesarios guardar el valor order_int_external_pk.
  • Aunque el campo extra es opcional, si no necesitas o no deseas llenarlo, puedes omitirlo del cuerpo de la solicitud.

Código 400

Si ocurre un error debido a una solicitud malformada, el servidor devuelve:

{
    "message": "Error."
}

🚧

Límite:

Este endpoint está sujeto a un límite general de 2 peticiones por segundo.

Para cualquier duda y/o aclaración, ponte en contacto con tu KAM asignado o escribiendo a [email protected].

Updated 4 months ago