Skip to content

Mercately Retailers API (1.0.0)

La plataforma para desarrolladores de Mercately, está creada para ayudar a todos nuestros clientes y empoderarlos para que crezcan mejor. Nuestras API están diseñadas para permitir que los equipos de cualquier forma o tamaño construyan integraciones y aprovechar al máximo Mercately. Todas las API de Mercately se construyen usando convenciones REST y están diseñadas para tener una estructura de URL predecible. U tilizan muchas funciones HTTP estándar, incluidos métodos (POST, GET, PUT, DELETE) y códigos de respuesta de error.

Download OpenAPI description
index.json
index.yaml
Overview
URL
http://mercately.com/
E-mail
soporte@mercately.com
License
MIT
Terms of Service
Languages
Servers
Production server
https://app.mercately.com/
Shops API Production server
https://mercately.shop/

Agents

En Mercately, los agentes son conocidos como las personas que están en tu equipo de trabajo. Los agentes pueden estar atados a varios otros objetos como conversaciones, notas, tratos del embudo u órdenes.

Operations

Customers

En Mercately, todo contacto proveniente de conversaciones, compras o creados directamente se clasifica como cliente.

Operations

Deals

En Mercately, los embudos permiten visualizar el recorrido que sigues a tus clientes a traves de las negociaciones.

Operations

Messenger

En Mercately, una vez vinculado con Messenger, este api permite realizar múltiples operaciones para acceder a las conversaciones de Messenger.

Operations

WhatsApp

En Mercately, una vez vinculado con WhatsApp, este api permite realizar múltiples operaciones para acceder a las conversaciones de WhatsApp y enviar mensajes.

Operations

Flows

En Mercately, una vez creado uno o más flows, esta api permite realizar múltiples operaciones para obtener todos los flows.

Operations

Orders

Crea, actualiza y elimina órdenes en Mercately

Operations

Orders

Request

Obtén los datos de tus órdenes

Security
api-key
Query
created_fromstring(date)

busca las órdenes creadas desde una fecha en especifico

Example: created_from=2023-05-17
created_tostring(date)

busca las órdenes creadas hasta una fecha en especifico

Example: created_to=2023-05-17
pageinteger

busca la pagina específica de órdenes

Default 1
curl -i -X GET \
  'https://mercately.shop/api/v1/orders?created_from=2023-05-17&created_to=2023-05-17&page=1' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
ordersArray of objects
total_pagesinteger
Response
application/json
{
  "orders": [
    { … }
  ],
  "total_pages": 1
}

Create Order

Request

Crea una nueva órden, puedes enviar el número de teléfono o email del cliente si ya esta creado en mercately, si no existe, creará el cliente.

Security
api-key
Bodyapplication/json
orderobject
curl -i -X POST \
  https://mercately.shop/api/v1/orders \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "order": {
      "sales_channel": "string",
      "notes": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "delivery_method": "send_order",
      "status": "pending",
      "shipping_value": 0.1,
      "customer_attributes": {
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string"
      },
      "order_items_attributes": [
        {
          "product_id": "string",
          "quantity": 0,
          "unit_price": 0.1
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/json
messagestring
orderobject
Response
application/json
{
  "message": "Órden creada con éxito",
  "order": {
    "web_id": "aAKpT9laN5",
    "status": "pending",
    "subtotal": "400.0",
    "tax_amount": "0.0",
    "total": "405.0",
    "shipping_value": "5.0",
    "sales_channel": null,
    "notes": "New notes",
    "created_at": "2023-06-12T18:26:58.534Z",
    "archived": false,
    "customer": { … },
    "order_items": [ … ]
  }
}

Order

Request

Actualiza una órden buscada su id

Security
api-key
Bodyapplication/json
orderobject
curl -i -X PUT \
  https://mercately.shop/api/v1/orders/web_id \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "order": {
      "sales_channel": "string",
      "notes": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "delivery_method": "send_order",
      "status": "pending",
      "shipping_value": 0.1,
      "customer_attributes": {
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string"
      },
      "order_items_attributes": [
        {
          "product_id": "string",
          "quantity": 0,
          "unit_price": 0.1
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
string
Response
application/json
{
  "message": "Órden actualizada con éxito",
  "order": {
    "web_id": "4Bs2mKblN3",
    "status": "success",
    "subtotal": "60.0",
    "tax_amount": "0.0",
    "total": "65.0",
    "shipping_value": "5.0",
    "sales_channel": null,
    "notes": "New notes",
    "created_at": "2023-06-13T03:31:06.825Z",
    "archived": false,
    "customer": { … },
    "order_items": [ … ]
  }
}

Orders

Request

Borra una órden

Security
api-key
curl -i -X DELETE \
  https://mercately.shop/api/v1/orders/web_id \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
string
Response
application/json
{
  "message": "Órden borrada con éxito"
}

Products

Crea, actualiza y elimina productos en Mercately

Operations

Categories

Obtén todas las categorías creadas en Mercately

Operations

Customer events

Operations
Copyleft © Mercately Inc.