Mercately Shops API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@mercately.com URL: http://shop.mercately.com/ Terms of Service

Introduction

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.

Orders

Crea, actualiza y elimina órdenes en Mercately

Orders

Obtén los datos de tus órdenes

Securityapi-key

Request

query Parameters

page	integer busca la pagina específica de órdenes

Responses

200

OK

400

Unauthorized

get/api/v1/orders

Request samples

Response samples

200

application/json

{"orders": [{"web_id": "EzLGaK0YZa",
"status": "pending",
"subtotal": "200.0",
"tax_amount": "0.0",
"total": "200.0",
"shipping_value": "0.0",
"notes": "",
"sales_channel": null,
"created_at": "2023-05-17T01:42:57.624Z",
"archived": false,
"customer": {"first_name": "Henry ",
"last_name": "Tonato",
"email": "henry@gmail.com",
"phone": "593995141472",
"address": "",
"city": "",
"state": "",
"country_id": "EC",
"zip_code": "",
"id_number": "",
"document_label": null,
"web_id": "EleO7OTOer"
},
"order_items": [{"id": 58779,
"quantity": 1,
"unit_price": "200.0",
"total": "200.0",
"title": "Mensajes",
"sku": "Col.2556",
"image_url": { }
}
]
}
],
"total_pages": 1
}

Create Order

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.

Securityapi-key

Request

Request Body schema: application/json

object

Responses

200

OK

400

Unauthorized

post/api/v1/orders

Request samples

application/json

{"order": {"sales_channel": "string",
"notes": "string",
"address": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"delivery_method": "send_order",
"status": "pending",
"shipping_value": 0,
"customer_attributes": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string"
},
"order_items_attributes": [{"product_id": "string",
"quantity": 0,
"unit_price": 0
}
]
}
}

Response samples

200

application/json

{"message": "Órden creada con éxito",
"product": {"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": {"first_name": "Juan",
"last_name": "Campos",
"email": "juan@email42.com",
"phone": "593996459124",
"address": "",
"city": "",
"state": "",
"country_id": "EC",
"zip_code": "",
"id_number": "",
"document_label": "cedula",
"web_id": "bReccZpRjO"
},
"order_items": [{"quantity": 2,
"unit_price": "200.0",
"total": "400.0",
"title": "Mensajes",
"sku": "Col.2556",
"image_url": { }
}
]
}
}

Order

Actualiza una órden buscada su id

Securityapi-key

Request

Request Body schema: application/json

object

Responses

200

OK

400

Unauthorized

404

Not found

put/api/v1/orders/web_id

Request samples

application/json

{"order": {"sales_channel": "string",
"notes": "string",
"address": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"delivery_method": "send_order",
"status": "pending",
"shipping_value": 0,
"customer_attributes": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string"
},
"order_items_attributes": [{"product_id": "string",
"quantity": 0,
"unit_price": 0
}
]
}
}

Response samples

200

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": {"first_name": "Henry",
"last_name": "Campos",
"email": null,
"phone": null,
"address": null,
"city": null,
"state": null,
"country_id": null,
"zip_code": null,
"id_number": null,
"document_label": null,
"web_id": "sVnez19hSa"
},
"order_items": [{"quantity": 3,
"unit_price": "20.0",
"total": "60.0",
"title": "Mensajes",
"sku": "Col.2556",
"image_url": { }
}
]
}
}

Orders

Borra una órden

Securityapi-key

Responses

200

OK

400

Unauthorized

404

Not found

delete/api/v1/orders/web_id

Request samples

Response samples

200

application/json

{"message": "Órden borrada con éxito"
}

Products

Crea, actualiza y elimina productos en Mercately

Products

Obtén los datos de tus productos

Securityapi-key

Request

query Parameters

page	integer busca la pagina específica de productos

Responses

200

OK

400

Unauthorized

get/api/v1/products

Request samples

Response samples

200

application/json

{"products": [{"web_id": "CRasFSldo7",
"title": "Mensajes",
"description": "Paquete mensajes Outbound e Inbound Colombia",
"quantity": 13,
"price": "200.0",
"active": true,
"url": null,
"sku": "Col.2556",
"wholesale_price": null,
"images": [ ],
"subcategory": {"name": "Alámbricos",
"web_id": "GETPvRKnBD"
},
"category": {"name": "Tecnología",
"web_id": "ljsJpi0fTR"
}
}
],
"total_pages": 4
}

Create Product

Crea un nuevo producto

Securityapi-key

Request

Request Body schema: application/json

object (Product)

Responses

200

OK

400

Unauthorized

post/api/v1/products

Request samples

application/json

{"product": {"title": "string",
"description": "string",
"sku": "string",
"quantity": 0,
"active": true,
"price": 0,
"subcategory_id": "string",
"image_urls": ["string"
]
}
}

Response samples

200

application/json

{"message": "Producto creado con éxito",
"product": {"web_id": "FzOWVvUwbC",
"title": "Product 001",
"description": "Product 001",
"quantity": 20,
"price": "1.5",
"active": true,
"url": null,
"sku": "p004",
"wholesale_price": "0.0",
"images": ["https://d3a4wxp51vazl1.cloudfront.net/uploads/506/product_attachment/FzOWVvUwbC/qrewrwYdhfNDCqW3hv4MTiwFq.jpg"
],
"subcategory": {"name": "Alámbricos",
"web_id": "GETPvRKnBD"
},
"category": {"name": "Tecnología",
"web_id": "ljsJpi0fTR"
}
}
}

Product

Obtén los datos de un producto en especifico buscado su id

Securityapi-key

Request

query Parameters

web_id	string The web_id of the product
sku	string The SKU of the product

Responses

200

OK

400

Unauthorized

404

Not found

get/api/v1/products/:id_or_sku

Request samples

Response samples

200

application/json

{"web_id": "CRasFSldo7",
"title": "Mensajes",
"description": "Paquete de mensajes Outbound",
"quantity": 13,
"price": "200.0",
"active": true,
"url": null,
"sku": "Col.2556",
"wholesale_price": null,
"images": [ ],
"subcategory": {"web_id": "GETPvRKnBD",
"name": "Alámbricos",
"description": "",
"products_count": 5,
"active_products_count": 2
},
"category": {"web_id": "ljsJpi0fTR",
"name": "Tecnología",
"description": "",
"products_count": 11,
"active_products_count": 6
}
}

Product

Actualiza un producto buscado su id

Securityapi-key

Request

Request Body schema: application/json

object (Product)

Responses

200

OK

400

Unauthorized

404

Not found

put/api/v1/product/web_id

Request samples

application/json

{"product": {"title": "string",
"description": "string",
"sku": "string",
"quantity": 0,
"active": true,
"price": 0,
"subcategory_id": "string",
"image_urls": ["string"
]
}
}

Response samples

200

application/json

{"message": "Producto actualizado con éxito",
"product": {"web_id": "FzOWVvUwbC",
"title": "Product 001",
"description": "Product 001",
"quantity": 20,
"price": "1.5",
"active": true,
"url": null,
"sku": "p004",
"wholesale_price": "0.0",
"images": ["https://d3a4wxp51vazl1.cloudfront.net/uploads/506/product_attachment/FzOWVvUwbC/qrGZwYdhfewrW3hv4MTiwFq.jpg"
],
"subcategory": {"name": "Alámbricos",
"web_id": "GETPvRKnBD"
},
"category": {"name": "Tecnología",
"web_id": "ljsJpi0fTR"
}
}
}

Product

Borra un producto buscado su id

Securityapi-key

Responses

200

OK

400

Unauthorized

404

Not found

delete/api/v1/product/web_id

Request samples

Response samples

200

application/json

{"message": "Producto eliminado con éxito",
"product": {"web_id": "tUCJZrCUs5",
"title": "Abrigo borrego",
"description": "Abrigo crema con lana de borrego.\r\nTallas: XS, S, M, L, XL, XXL.",
"quantity": 41,
"price": "8.0",
"active": true,
"url": null,
"sku": "AB.577",
"wholesale_price": "6.0",
"images": ["https://d3a4wxp51vazl1.cloudfront.net/uploads/506/product_attachment/tUCJZrCUs5/7-01.jpg",
"https://d3a4wxp51vazl1.cloudfront.net/uploads/506/product_attachment/tUCJZrCUs5/8-01.jpg",
"https://d3a4wxp51vazl1.cloudfront.net/uploads/506/product_attachment/tUCJZrCUs5/9-01.jpg"
],
"subcategory": {"name": "Abrigos",
"web_id": "EM5FJCF7sY"
},
"category": {"name": "Abrigos y chaquetas",
"web_id": "maFDOHylFB"
}
}
}

Categories

Obtén todas las categorías creadas en Mercately