Punto final
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Solicitud HTTPS
| Campo | Notas |
|---|---|
| Método HTTP | POST |
| URL del punto final | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocolo | HTTPS |
| Formato del mensaje | JSON |
| Encabezado HTTP de aceptación | Accept: application/json |
| Encabezado HTTP de tipo de contenido | Content-Type: application/json |
Pares clave/valor JSON en el cuerpo de la solicitud
Ejemplo
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Definiciones JSON de solicitud
| Campo | Notas |
|---|---|
merchantOrderId REQUERIDO | Este parámetro se utiliza para pasar el ID de pedido interno de su tienda al pedido en el sistema de Zonos. Se recomienda para una mejor conciliación, comunicación y auditoría. cadena |
orderId REQUERIDO | El ID de pedido de Zonos - se puede pasar con o sin el ID de su tienda y guion (Ejemplo: 123-45678 o 45678). Nota: Después de completar el pedido y el pago, el cliente será redirigido a una página de Finalización de Pedido / Agradecimiento por Pedido alojada en su dominio. La URL contendrá un parámetro de cadena de consulta "orderId" que contendrá este valor. entero / cadena |
secret REQUERIDO | GUID secreto de API proporcionado por Zonos. cadena |
store REQUERIDO | ID de tienda proporcionado por Zonos. entero |
Respuesta HTTPS
Ejemplo de respuesta exitosa
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Respuesta de error de ejemplo
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Respuestas de error HTTP
| Código de error | Definición |
|---|---|
| 406 - No aceptable | Entidad HTML. La cabecera HTTP "Accept" no es válida. |
| 415 - Tipo de medio no soportado | Entidad HTML. La cabecera HTTP "Content-Type" no es válida. |
| 200 | "error": "no se pudo analizar la entrada" |
| 200 | "error": "Se requiere el parámetro orderId para procesar UpdateMerchantOrderId" |
| 200 | "error": "Se requiere el parámetro merchantOrderId para actualizar MerchantOrderId." |
| 200 | "error": "orderId: 999-99999 no es un orderId válido" |
| 200 | "error": "No se pudo recuperar el pedido para actualizar MerchantOrderId para orderId: 999-99999" |
| 200 | "error": "No se pudo procesar la actualización del ID de pedido del comerciante." |
| 200 | "error": "Credenciales de seguridad inválidas" |
Definiciones JSON de respuesta
| Mensaje | Definición |
|---|---|
error | Este parámetro solo estará presente en la respuesta cuando se haya producido un error y contendrá una descripción de la causa. string |
success | Este parámetro contendrá un resumen de la actualización. string |
Actualizar número de pedido
Aprende cómo funciona el punto final para actualizar un número de pedido.
El punto final
updateMerchantOrderIdse utiliza para actualizar un pedido en el sistema de Zonos con el ID de pedido de tu tienda para una mejor conciliación, comunicación y auditoría.