Update Sale Status

curl --request PUT \
  --url https://api.example.com/api/sales/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>",
  "trackingCode": "<string>"
}
'

import requests

url = "https://api.example.com/api/sales/:id/status"

payload = {
    "status": "<string>",
    "trackingCode": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>', trackingCode: '<string>'})
};

fetch('https://api.example.com/api/sales/:id/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/sales/:id/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>',
    'trackingCode' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/sales/:id/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/sales/:id/status")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sales/:id/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 123,
    "fecha": "<string>",
    "montoTotal": 123,
    "estado": "<string>",
    "medioPago": "<string>",
    "tipoEntrega": "<string>",
    "costoEnvio": 123,
    "clienteId": 123,
    "lineasVenta": [
      {}
    ]
  },
  "error": "<string>"
}

PUT

api

sales

:id

status

Update Sale Status

curl --request PUT \
  --url https://api.example.com/api/sales/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>",
  "trackingCode": "<string>"
}
'

import requests

url = "https://api.example.com/api/sales/:id/status"

payload = {
    "status": "<string>",
    "trackingCode": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>', trackingCode: '<string>'})
};

fetch('https://api.example.com/api/sales/:id/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/sales/:id/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>',
    'trackingCode' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/sales/:id/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/sales/:id/status")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sales/:id/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\",\n  \"trackingCode\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 123,
    "fecha": "<string>",
    "montoTotal": 123,
    "estado": "<string>",
    "medioPago": "<string>",
    "tipoEntrega": "<string>",
    "costoEnvio": 123,
    "clienteId": 123,
    "lineasVenta": [
      {}
    ]
  },
  "error": "<string>"
}

Authentication

This endpoint requires authentication with admin privileges.

Path Parameters

number

required

The unique identifier of the sale to update

Request Body

string

required

The new status for the sale. Must be one of:

PENDIENTE_PAGO - Pending payment
PENDIENTE_APROBACION - Pending approval (awaiting payment verification)
APROBADO - Approved and ready to be prepared
ENVIADO - Shipped/dispatched
ENTREGADO - Delivered to customer
RECHAZADO - Rejected (payment failed or order cancelled by admin)
CANCELADO - Cancelled by customer or admin

Response

boolean

Indicates if the request was successful

object

The updated sale object

number

Sale ID

string

Sale date (ISO 8601 timestamp)

number

Total amount including shipping

string

Updated sale status

string

Payment method

string

Delivery type

number

Shipping cost

number

Customer ID

array

Array of line items

string

Error message if the request failed

Dispatch Sale

PUT /api/sales/:id/dispatch Specialized endpoint to mark a sale as dispatched with tracking information. Request Body:

string

required

Tracking code for the shipment

This endpoint automatically updates the status to ENVIADO and sets the tracking code.

Cancel Order

PUT /api/sales/:id/cancel Allows users to cancel their own order. Updates the status to CANCELADO and restores product stock. Authentication: Regular user authentication (users can cancel their own orders)

Sale Status Workflow

Typical status progression:

PENDIENTE_PAGO - Initial state after sale creation
PENDIENTE_APROBACION - Payment proof uploaded, awaiting verification
APROBADO - Payment confirmed, order ready for preparation
ENVIADO - Order shipped with tracking code
ENTREGADO - Order delivered to customer

Alternative flows:

RECHAZADO - Payment failed or order rejected
CANCELADO - Order cancelled by customer or admin

Example Request

{
  "status": "APROBADO"
}

Example Response

{
  "success": true,
  "data": {
    "id": 789,
    "fecha": "2026-03-05T10:30:00.000Z",
    "montoTotal": 50000,
    "estado": "APROBADO",
    "medioPago": "TRANSFERENCIA",
    "tipoEntrega": "ENVIO",
    "costoEnvio": 5000,
    "clienteId": 42,
    "direccionEnvio": "Av. Corrientes 1234",
    "lineasVenta": [
      {
        "id": 1,
        "productoId": 123,
        "cantidad": 2,
        "subTotal": 30000
      },
      {
        "id": 2,
        "productoId": 456,
        "cantidad": 1,
        "subTotal": 15000
      }
    ]
  }
}

Example Request - Dispatch Sale

PUT /api/sales/789/dispatch

{
  "trackingCode": "AR123456789"
}

Example Response - Dispatch Sale

{
  "success": true,
  "data": {
    "id": 789,
    "estado": "ENVIADO",
    "codigoSeguimiento": "AR123456789",
    "montoTotal": 50000,
    "fecha": "2026-03-05T10:30:00.000Z"
  }
}

Example Request - Cancel Order

PUT /api/sales/789/cancel

Example Response - Cancel Order

{
  "success": true,
  "data": {
    "id": 789,
    "estado": "CANCELADO",
    "montoTotal": 50000,
    "fecha": "2026-03-05T10:30:00.000Z"
  }
}

Error Responses

Invalid Status (400)

{
  "success": false,
  "error": "Invalid status"
}

Missing Tracking Code (400) - Dispatch endpoint

{
  "success": false,
  "error": "Tracking required"
}

Unauthorized (401)

{
  "success": false,
  "error": "Unauthorized"
}

Forbidden - Not Admin (403)

{
  "success": false,
  "error": "Admin access required"
}

Sale Not Found (404)

{
  "success": false,
  "error": "Venta no encontrada"
}

Notes

Only admin users can update sale status via /api/sales/:id/status
The /api/sales/:id/dispatch endpoint is a convenience method for shipping orders
The /api/sales/:id/cancel endpoint can be used by regular users to cancel their own orders
Cancelling an order restores the product stock that was reserved
Status changes may trigger email notifications to customers
Once a sale is marked as ENTREGADO, it should not be changed to other statuses
Status transitions should follow the logical workflow to maintain data integrity

⌘I

Authentication

Products

Cart & Checkout

Sales

Admin

Update Sale Status

Authentication

Path Parameters

Request Body

Response

Dispatch Sale

Cancel Order

Sale Status Workflow

Example Request

Example Response

Example Request - Dispatch Sale

Example Response - Dispatch Sale

Example Request - Cancel Order

Example Response - Cancel Order

Error Responses

Invalid Status (400)

Missing Tracking Code (400) - Dispatch endpoint

Unauthorized (401)

Forbidden - Not Admin (403)

Sale Not Found (404)

Notes

​Authentication

​Path Parameters

​Request Body

​Response

​Related Endpoints

​Dispatch Sale

​Cancel Order

​Sale Status Workflow

​Example Request

​Example Response

​Example Request - Dispatch Sale

​Example Response - Dispatch Sale

​Example Request - Cancel Order

​Example Response - Cancel Order

​Error Responses

​Invalid Status (400)

​Missing Tracking Code (400) - Dispatch endpoint

​Unauthorized (401)

​Forbidden - Not Admin (403)

​Sale Not Found (404)

​Notes

Authentication

Path Parameters

Request Body

Response

Related Endpoints

Dispatch Sale

Cancel Order

Sale Status Workflow

Example Request

Example Response

Example Request - Dispatch Sale

Example Response - Dispatch Sale

Example Request - Cancel Order

Example Response - Cancel Order

Error Responses

Invalid Status (400)

Missing Tracking Code (400) - Dispatch endpoint

Unauthorized (401)

Forbidden - Not Admin (403)

Sale Not Found (404)

Notes