PATCH
/
orders
/
{id}
/
orderStatus
cURL
curl --request PATCH \
  --url https://api.getjusto.com/api/v2/orders/{id}/orderStatus \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "orderStatus": "<string>"
}'
{
  "status": "ok",
  "data": {
    "_id": "<string>",
    "orderStatus": "<string>",
    "isScheduled": true,
    "websiteId": "<string>",
    "code": "<string>",
    "createdAt": "<string>",
    "fullCode": "<string>",
    "userId": "<string>",
    "storeId": "<string>",
    "address": {
      "_id": "<string>",
      "placeId": "<string>",
      "address": "<string>",
      "addressSecondary": "<string>",
      "location": {
        "lat": 123,
        "lng": 123
      },
      "streetAddress": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "directions": {
        "duration": 123,
        "distance": 123
      }
    },
    "menuId": "<string>",
    "deliveryType": "<string>",
    "deliverAt": "2023-11-07T05:31:56Z",
    "paymentType": "<string>",
    "paymentTypeLabel": "<string>",
    "paymentTypeIsIntegration": true,
    "otherPaymentType": "<string>",
    "amountToPay": 123,
    "deliveryFee": 123,
    "deliveryFeeWithoutDiscount": 123,
    "serviceFee": 123,
    "itemsPrice": 123,
    "totalPrice": 123,
    "totalPriceBeforeDiscountsAfterProductDiscount": 123,
    "discountedAmountAfterProductDiscount": 123,
    "justoCoinsDiscount": 123,
    "invoiceTotalPrice": 123,
    "amountFinancedByWebsite": 123,
    "amountFinancedByJusto": 123,
    "expectedPreparationDuration": 123,
    "deliveryDuration": 123,
    "cardId": "<string>",
    "channel": "<string>",
    "source": "<string>",
    "buyerName": "<string>",
    "couponId": "<string>",
    "couponName": "<string>",
    "couponDiscount": 123,
    "flagColor": "<string>",
    "store": {
      "_id": "<string>",
      "websiteId": "<string>",
      "name": "<string>",
      "acceptDelivery": true,
      "currentPreparationDuration": 123,
      "currentDeliveryDuration": 123,
      "phone": "<string>",
      "address": {
        "_id": "<string>",
        "placeId": "<string>",
        "address": "<string>",
        "addressSecondary": "<string>",
        "location": {
          "lat": 123,
          "lng": 123
        },
        "streetAddress": "<string>",
        "locality": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "directions": {
          "duration": 123,
          "distance": 123
        }
      },
      "externalId": "<string>",
      "schedule": {
        "closedDays": [
          "<any>"
        ],
        "availableAtPeriods": true,
        "openPeriods": [
          {
            "daysOfWeek": [
              123
            ],
            "fromMinute": 123,
            "toMinute": 123,
            "specialPeriods": [
              "<any>"
            ],
            "timezone": "<string>",
            "availableStateValidUntil": "<string>",
            "isAvailableNow": true,
            "updatedCacheAt": "<string>"
          }
        ]
      }
    },
    "items": [
      {
        "product": {
          "_id": "<string>",
          "name": "<string>",
          "externalId": "<string>"
        },
        "unitPrice": 123,
        "baseUnitPrice": 123,
        "productPrice": 123,
        "baseProductPrice": 123,
        "amount": 123,
        "comment": "<string>",
        "modifiers": [
          "<any>"
        ],
        "options": [
          "<any>"
        ]
      }
    ],
    "transaction": {},
    "devolutions": [
      {
        "_id": "<string>",
        "amount": 123,
        "completedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "deliveries": [
      {}
    ],
    "charges": {
      "platformFee": {
        "amount": 123,
        "totalAmount": 123,
        "tax": 123,
        "count": 123
      }
    },
    "orderParams": {
      "isGift": true
    },
    "billing": {},
    "clonedOrder": {},
    "parentOrder": {},
    "hasManagedDelivery": true,
    "loyaltyTransaction": {},
    "cancellationInfo": {},
    "websiteCoinsDiscount": 123
  }
}

​
Descripción

Este método fue diseñado con el fin de modificar el estado de un pedido, mediante este endpoint se puede actualizar el estado a uno de “delivering”, “done” o “cancelled”. Notar que un cambio de estado puede poner en marcha un gran número de procesos internos como, la generación automática de devoluciones cuando un pedido se “cancela”, y para esto hay que cumplir ciertas condiciones, especialmente cuando uno selecciona “cancelled” el pedido.

​
NOTA 1:

Si se cancela un pedido, el sistema generará una devolución automatica siempre y cuando el medio de pago lo permita. Los pedidos con entrega en el local o con pago en efectivo no generan devoluciones.

​
NOTA 2:

Se podrán ver los campos reason, reasonMessage y category en el objeto cancellationInfo de los pedidos cancelados, tanto para aquellos que no generen devoluciones, como para aquellos pedidos cancelados que si generen devoluciones.

​
NOTA 3:

Se podrán ver los campos amount, reason, reasonMessage y category de los pedidos cancelados con devoluciones en la lista devolutions.

​
NOTA 4:

Si se cancela un pedido, este NO debe tener despachos activos. Si esto ocurre la petición será rechazada con el siguiente error: 
{
    "status": "error",
    "error": "El pedido no se puede cancelar porque esta activo"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

ID de la orden

Body

application/json
​
orderStatus
string
required

Estado de la orden

Response

Operación exitosa

​
status
string

Resultado de la operación

Example:

"ok"

​
data
object