Documentación

Estructura estandarizada

Este endpoint permite consultar las ordenes de todos los canales con una misma estructura estandarizada.

Suggest Edits

🚧

Endpoint bajo solicitud

Este recurso se habilita únicamente para las cuentas que lo solicitan. Si deseas utilizarlo, por favor haz tu solicitud a este correo. Te lo habilitaremos dentro de 48 horas.

Estructura

Yuju procesa las órdenes de todos los canales de ventas (marketplaces y ecommerce propio) para entregar en este endpoint una misma estructura.

En esta estructura estandarizada, el pedido siempre viene de la siguiente forma:

  • Todos los SKUs comprados del carrito están dentro de un solo pedido.
  • La cantidad de piezas agrupada por SKU. Cada línea de SKU muestra la cantidad de piezas vendidas del SKU correspondiente.

Ejemplo:

  • Línea 1: SKU 1 / 1 pieza.
  • Línea 2: SKU 2 / 3 piezas.

📘

Notas Importantes:

  • La consulta del endpoint se debe hacer siempre con el ID dado por Yuju en el webhook. Para Mercado Libre carrito, se usa el pack_id y para todos los demás casos se usa el id_order.

  • Para las órdenes de Mercado Libre tipo carrito, el webhook se envía con el ID del carrito, el cual es el ID único que permite agrupar los pedidos del carrito. Utiliza ese ID (el pack_id) para consultar el endpoint. Conclusión: El id_order a usar debe ser el pack_id.

  • Cuando se unifican ítems en uno solo, se genera un nuevo id_item basado en los ítems que lo componen.

  • Yuju empieza a procesar los pedidos para regresarlos todos en la estructura estandarizada a partir de la fecha en la cual se habilita tu acceso al endpoint.

    Por lo tanto, no incluye las órdenes anteriores a la habilitación de la funcionalidad que tienen una estructura distinta a la estandarizada (ejemplo: pedidos de carrito de MELI). El endpoint regresa todas las demás órdenes sin importar su fecha de creación.

    Para consultar un historial completo anterior a la fecha de habilitación, utiliza la estructura normal.

Endpoint

GET https://api.tp.yuju.io/std-orders/?id_channel=4301&id_order=50035

Debes usar Query Params para este endpoint

Parámetros de consulta

Query ParamDescripciónEjemplo
id_orderId de la ordenDBG0210232023
id_channelId del canal4301

Respuesta

{
  "id_shop": 275,
  "id_channel": 13,
  "id_order": "200472742",
  "billing_address": null,
  "cancel_detail": null,
  "cart_orders": [
    "64563167704511",
    "64563167704512"
  ],
  "coupon": null,
  "currency": "mxn",
  "customer": {
    "first_name": "victor",
    "last_name": "martinez",
    "email": "[email protected]",
    "phone": null,
    "phone2": null,
    "nickname": null,
    "customer_id": null,
    "doc_type": null,
    "doc_number": null
  },
  "customer_detail": null,
  "delivery_deadline": "2022-02-23",
  "discounts": [],
  "extra": {
    "cart_shipping_cost": 2000.0,
    "cart_total": 6000.0,
    "cart_seller_shipping_cost": 0,
    "cart_marketplace_fee": 900.0,
    "pack_id": "200472742"
  },
  "extra_charges": [],
  "ff_type": "fbm",
  "fulfillment_type": null,
  "invoice": {
    "error": "",
    "pk": "",
    "required": "0",
    "rfc": "",
    "status": ""
  },
  "marketplace_fee": 900.0,
  "meli_chat_status": null,
  "notes": false,
  "paid_total": 8000.0,
  "paid_total_to_seller": 5100.0,
  "payment_accredited_at": "2022-02-23T15:51:13",
  "payment_detail": [],
  "payment_method": "credit_card",
  "payment_references": [
    "286273239"
  ],
  "reference": "200472742",
  "seller_shipping_cost": 0.0,
  "shipping_address": {
    "id": "540202",
    "address": "SUSANA 4563",
    "street_number": "4563",
    "street_name": "SUSANA",
    "neighborhood": "GEOVILLAS DE SANTA BARBARA",
    "region": "Estado De México",
    "city": "Ixtapaluca",
    "country": "México",
    "postal_code": "56535",
    "reference": "MZ. 40 LT.2 FRACCIONAMIENTO JARDIN DIAMANTE Entre: SUSON Y SULTANA",
    "first_name": "victor martinez",
    "last_name": "",
    "phone": null,
    "email": null,
    "lat": null,
    "lon": null
  },
  "shipping_cost": 2000.0,
  "shipping_detail": null,
  "tags": [
    "shipment_me2",
    "logistic_cross_docking",
    "fake_order"
  ],
  "total": 6000.0,
  "order_components": [
    {
      "id_order": "64563167704511",
      "reference": "64563167704511",
      "status": "open",
      "progress": [
        {
          "name": "paid",
          "status": "done"
        },
        {
          "name": "ready_to_ship",
          "status": "done"
        },
        {
          "name": "shipped",
          "status": "pending"
        },
        {
          "name": "delivered",
          "status": "pending"
        }
      ],
      "ff_type": "fbm"
    },
    {
      "id_order": "64563167704512",
      "reference": "64563167704512",
      "status": "open",
      "progress": [
        {
          "name": "paid",
          "status": "done"
        },
        {
          "name": "ready_to_ship",
          "status": "pending"
        },
        {
          "name": "shipped",
          "status": "pending"
        },
        {
          "name": "delivered",
          "status": "pending"
        }
      ],
      "ff_type": "fbm"
    }
  ],
  "progress": [
    {
      "name": "paid",
      "status": "done"
    },
    {
      "name": "ready_to_ship",
      "status": "done"
    },
    {
      "name": "shipped",
      "status": "pending"
    },
    {
      "name": "delivered",
      "status": "pending"
    }
  ],
  "status": "open",
  "order_updated_at": "2022-02-23T15:54:37",
  "order_created_at": "2022-02-23T15:51:13",
  "actions": [
    "print_delivery_label",
    "feedback",
    "cancel_feedback"
  ],
  "claims": [],
  "items": [
    {
      "id_shop": 275,
      "id_channel": 13,
      "id_order": "64563167704511",
      "channel_sku": "sku1",
      "combo_components": [],
      "comments": null,
      "currency": "mxn",
      "delivery_time": null,
      "discount": null,
      "extra": null,
      "extra_charges": [],
      "ff_type": "fbm",
      "id_product": null,
      "is_combo": false,
      "marketplace_fee": 450.0,
      "name": "test1",
      "price": 3000.0,
      "product": {
        "id_product": null,
        "id_parent": null,
        "upc": null,
        "ean": null,
        "isbn_10": null,
        "isbn_13": null,
        "color": null,
        "size": null,
        "custom_variation": null,
        "custom_variation_name": null,
        "stock": null,
        "price": null,
        "color_text": null,
        "discount": null,
        "discount_to": null,
        "discount_from": null,
        "special_price": null,
        "special_price_amz": null,
        "special_price_linio": null,
        "secondary_color": null,
        "asin": null,
        "gtin": null,
        "jan": null,
        "mpn": null,
        "part_number": null,
        "model": null,
        "brand": null,
        "official_store_id": null,
        "images": [],
        "is_virtual": false,
        "name": null,
        "custom_s1": null,
        "custom_s2": null,
        "custom_s3": null,
        "custom_s4": null,
        "custom_s5": null,
        "custom_i1": null,
        "custom_i2": null,
        "custom_i3": null,
        "custom_i4": null,
        "custom_i5": null,
        "custom_f1": null,
        "custom_f2": null,
        "custom_f3": null,
        "custom_f4": null,
        "custom_f5": null,
        "cost": null,
        "channel_stock": null,
        "shipping_width": null,
        "shipping_height": null,
        "shipping_depth": null,
        "dimensions_unit": null,
        "weight": null,
        "weight_unit": null,
        "tags": null,
        "msrp": null,
        "product_code_sat": null,
        "measure_unit_code_sat": null
      },
      "product_id": "MXX836",
      "product_original_price": null,
      "product_special_price": null,
      "sku": "sku1",
      "id_item": "sku1",
      "quantity": 1,
      "item_components": [
        {
          "carrier": "Prioritario a domicilio",
          "quantity": 1,
          "coupon_code": null,
          "discounts": [],
          "id_item": "sku1",
          "tracking_code": "MELI281730",
          "coupon_value": null,
          "providers": null,
          "status": "paid"
        }
      ],
      "shipments": []
    },
    {
      "id_shop": 275,
      "id_channel": 13,
      "id_order": "64563167704512",
      "channel_sku": "sku2",
      "combo_components": [],
      "comments": null,
      "currency": "mxn",
      "delivery_time": null,
      "discount": null,
      "extra": null,
      "extra_charges": [],
      "ff_type": "fbm",
      "id_product": null,
      "is_combo": false,
      "marketplace_fee": 450.0,
      "name": "test2",
      "price": 1000.0,
      "product": {
        "id_product": null,
        "id_parent": null,
        "upc": null,
        "ean": null,
        "isbn_10": null,
        "isbn_13": null,
        "color": null,
        "size": null,
        "custom_variation": null,
        "custom_variation_name": null,
        "stock": null,
        "price": null,
        "color_text": null,
        "discount": null,
        "discount_to": null,
        "discount_from": null,
        "special_price": null,
        "special_price_amz": null,
        "special_price_linio": null,
        "secondary_color": null,
        "asin": null,
        "gtin": null,
        "jan": null,
        "mpn": null,
        "part_number": null,
        "model": null,
        "brand": null,
        "official_store_id": null,
        "images": [],
        "is_virtual": false,
        "name": null,
        "custom_s1": null,
        "custom_s2": null,
        "custom_s3": null,
        "custom_s4": null,
        "custom_s5": null,
        "custom_i1": null,
        "custom_i2": null,
        "custom_i3": null,
        "custom_i4": null,
        "custom_i5": null,
        "custom_f1": null,
        "custom_f2": null,
        "custom_f3": null,
        "custom_f4": null,
        "custom_f5": null,
        "cost": null,
        "channel_stock": null,
        "shipping_width": null,
        "shipping_height": null,
        "shipping_depth": null,
        "dimensions_unit": null,
        "weight": null,
        "weight_unit": null,
        "tags": null,
        "msrp": null,
        "product_code_sat": null,
        "measure_unit_code_sat": null
      },
      "product_id": "MXX243",
      "product_original_price": null,
      "product_special_price": null,
      "sku": "sku2",
      "id_item": "sku2",
      "quantity": 3,
      "item_components": [
        {
          "carrier": "Prioritario a domicilio",
          "quantity": 3,
          "coupon_code": null,
          "discounts": [],
          "id_item": "sku2",
          "tracking_code": "MELI281730",
          "coupon_value": null,
          "providers": null,
          "status": "paid"
        }
      ],
      "shipments": []
    }
  ]
}

Nota para tus pruebas:

Al consultar órdenes de prueba, ciertos campos pueden aparecer vacíos o NULL en el JSON. Ocurre cuando no se tiene una integración real para simular información.

Ejemplo con el campo "shipments": [], ya sea a nivel de orden o de ítem. Sin embargo, el entorno de producción regresará la información completa.

{
           "shipments": []
}


"shipments": [
                {
                    "carrier": "Estándar a domicilio",
                    "buffering_date": null,
                    "quantity": 2,
                    "status_history": {
                        "date_shipped": null,
                        "date_returned": null,
                        "date_delivered": null,
                        "date_first_visit": null,
                        "date_not_delivered": null,
                        "date_created": null,
                        "date_cancelled": null,
                        "date_first_printed": null,
                        "date_handling": "2024-08-15T13:36:53+00:00",
                        "date_delivered_estimated": null,
                        "date_ready_to_ship": "2024-08-15T13:36:54.395000+00:00"
                    },
                    "id_item": "IDITEM123",
                    "label_url_2": null,
                    "id": "43727617042",
                    "tracking_code": "MEL12345677",
                    "tracking_url": null,
                    "label_url": null,
                    "status": "pending"
                }   ]

Updated 4 months ago