Mark delivered (or picked up)

curl --request POST \
  --url https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "courierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier": "<string>",
  "trackingNumber": "<string>",
  "trackingUrl": "<string>"
}
'

import requests

url = "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver"

payload = {
    "courierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carrier": "<string>",
    "trackingNumber": "<string>",
    "trackingUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    courierId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    carrier: '<string>',
    trackingNumber: '<string>',
    trackingUrl: '<string>'
  })
};

fetch('https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver', 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-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'courierId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'carrier' => '<string>',
    'trackingNumber' => '<string>',
    'trackingUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver"

	payload := strings.NewReader("{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "code": "<string>",
  "status": "AWAITING_REVIEW",
  "paymentStatus": "UNPAID",
  "fulfillmentStatus": "UNFULFILLED",
  "source": "STOREFRONT",
  "createdAt": "2026-06-30T14:12:00Z",
  "updatedAt": "2026-06-30T14:12:00Z",
  "placedAt": "2026-06-30T14:12:00Z",
  "cancelledAt": "2026-06-30T14:12:00Z",
  "placedAsGuest": true,
  "comment": "<string>",
  "currencyCode": "USD",
  "subtotal": "1234.56",
  "taxTotal": "1234.56",
  "taxLines": [
    {
      "name": "<string>",
      "code": "<string>",
      "ratePercent": "19.00",
      "base": "1234.56",
      "amount": "1234.56"
    }
  ],
  "shippingTotal": "1234.56",
  "shippingTaxTotal": "1234.56",
  "discountTotal": "1234.56",
  "total": "1234.56",
  "priceList": {
    "id": "<string>",
    "name": "<string>"
  },
  "segment": {
    "id": "<string>",
    "name": "<string>"
  },
  "location": {
    "id": "<string>",
    "name": "<string>"
  },
  "shippingMethod": {
    "id": "<string>",
    "type": "DELIVERY",
    "label": "<string>",
    "payment": "PREPAID"
  },
  "courier": {
    "id": "<string>",
    "name": "<string>"
  },
  "courierBranch": {
    "id": "<string>",
    "name": "<string>",
    "addressLine": "<string>",
    "geoLevel1": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel2": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel3": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel4": {
      "name": "Miraflores",
      "code": "150122"
    }
  },
  "buyer": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "code": "<string>",
    "customerId": "<string>",
    "documentType": "<string>",
    "documentNumber": "<string>"
  },
  "billing": {
    "documentType": "<string>",
    "documentNumber": "<string>",
    "legalName": "<string>",
    "businessActivity": "<string>",
    "geoDivisionId": "<string>",
    "geoDivisionName": "<string>",
    "geoDivisionCode": "<string>",
    "geoDivisionDisplayPath": "<string>",
    "addressLine": "<string>"
  },
  "shippingAddress": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "geoLevel1": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel2": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel3": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel4": {
      "name": "Miraflores",
      "code": "150122"
    },
    "coordinates": {
      "latitude": -12.046374,
      "longitude": -77.042793
    },
    "recipientName": "<string>",
    "recipientPhone": "<string>",
    "instructions": "<string>",
    "customerAddressId": "<string>"
  },
  "payment": {
    "methodKind": "MANUAL",
    "methodName": "<string>",
    "paidVia": "CARD",
    "installments": 12,
    "installmentsInterest": "WITH_INTEREST",
    "reference": "<string>",
    "paidAt": "2026-06-30T14:12:00Z",
    "amountPaid": "1234.56"
  },
  "cancellation": {
    "reason": "<string>",
    "note": "<string>",
    "byMemberId": "<string>",
    "byName": "<string>"
  },
  "fulfillments": [
    {
      "carrier": "<string>",
      "trackingNumber": "<string>",
      "trackingUrl": "<string>",
      "preparingAt": "2026-06-30T14:12:00Z",
      "fulfilledAt": "2026-06-30T14:12:00Z",
      "deliveredAt": "2026-06-30T14:12:00Z"
    }
  ],
  "invoiceStatus": "NOT_INVOICED",
  "invoices": [
    {
      "id": "<string>",
      "number": "<string>",
      "issuedAt": "2026-06-30T14:12:00Z",
      "registeredAt": "2026-06-30T14:12:00Z"
    }
  ],
  "promotions": [
    {
      "id": "<string>",
      "code": "<string>",
      "title": "<string>",
      "class": "GOODS",
      "amount": "1234.56"
    }
  ],
  "items": [
    {
      "id": "<string>",
      "variantId": "<string>",
      "variantSku": "<string>",
      "productId": "<string>",
      "productName": "<string>",
      "productImageUrl": "<string>",
      "quantity": 2,
      "price": "1234.56",
      "listPrice": "1234.56",
      "discountTotal": "1234.56",
      "discountAllocations": [
        {
          "promotionId": "<string>",
          "amount": "1234.56"
        }
      ],
      "taxName": "<string>",
      "taxCode": "<string>",
      "taxRatePercent": "18.00",
      "subtotal": "1234.56",
      "taxTotal": "1234.56",
      "total": "1234.56",
      "components": [
        {
          "id": "<string>",
          "variantId": "<string>",
          "variantSku": "<string>",
          "productId": "<string>",
          "productName": "<string>",
          "quantityPerBundle": 3
        }
      ]
    }
  ],
  "transactions": [
    {
      "id": "<string>",
      "kind": "AUTHORIZATION",
      "status": "PENDING",
      "amount": "1234.56",
      "provider": "OPENPAY",
      "gatewayTransactionId": "<string>",
      "cardBrand": "<string>",
      "cardLast4": "<string>",
      "cardType": "CREDIT",
      "installments": 12,
      "installmentsInterest": "WITH_INTEREST",
      "authorizationCode": "<string>",
      "gatewayResultCode": "<string>",
      "errorCode": "<string>",
      "test": true,
      "processedAt": "2026-06-30T14:12:00Z",
      "createdAt": "2026-06-30T14:12:00Z"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

POST

orders

{id}

fulfillment

deliver

Mark delivered (or picked up)

curl --request POST \
  --url https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "courierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier": "<string>",
  "trackingNumber": "<string>",
  "trackingUrl": "<string>"
}
'

import requests

url = "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver"

payload = {
    "courierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carrier": "<string>",
    "trackingNumber": "<string>",
    "trackingUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    courierId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    carrier: '<string>',
    trackingNumber: '<string>',
    trackingUrl: '<string>'
  })
};

fetch('https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver', 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-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'courierId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'carrier' => '<string>',
    'trackingNumber' => '<string>',
    'trackingUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver"

	payload := strings.NewReader("{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/deliver")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"courierId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier\": \"<string>\",\n  \"trackingNumber\": \"<string>\",\n  \"trackingUrl\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "code": "<string>",
  "status": "AWAITING_REVIEW",
  "paymentStatus": "UNPAID",
  "fulfillmentStatus": "UNFULFILLED",
  "source": "STOREFRONT",
  "createdAt": "2026-06-30T14:12:00Z",
  "updatedAt": "2026-06-30T14:12:00Z",
  "placedAt": "2026-06-30T14:12:00Z",
  "cancelledAt": "2026-06-30T14:12:00Z",
  "placedAsGuest": true,
  "comment": "<string>",
  "currencyCode": "USD",
  "subtotal": "1234.56",
  "taxTotal": "1234.56",
  "taxLines": [
    {
      "name": "<string>",
      "code": "<string>",
      "ratePercent": "19.00",
      "base": "1234.56",
      "amount": "1234.56"
    }
  ],
  "shippingTotal": "1234.56",
  "shippingTaxTotal": "1234.56",
  "discountTotal": "1234.56",
  "total": "1234.56",
  "priceList": {
    "id": "<string>",
    "name": "<string>"
  },
  "segment": {
    "id": "<string>",
    "name": "<string>"
  },
  "location": {
    "id": "<string>",
    "name": "<string>"
  },
  "shippingMethod": {
    "id": "<string>",
    "type": "DELIVERY",
    "label": "<string>",
    "payment": "PREPAID"
  },
  "courier": {
    "id": "<string>",
    "name": "<string>"
  },
  "courierBranch": {
    "id": "<string>",
    "name": "<string>",
    "addressLine": "<string>",
    "geoLevel1": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel2": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel3": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel4": {
      "name": "Miraflores",
      "code": "150122"
    }
  },
  "buyer": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "code": "<string>",
    "customerId": "<string>",
    "documentType": "<string>",
    "documentNumber": "<string>"
  },
  "billing": {
    "documentType": "<string>",
    "documentNumber": "<string>",
    "legalName": "<string>",
    "businessActivity": "<string>",
    "geoDivisionId": "<string>",
    "geoDivisionName": "<string>",
    "geoDivisionCode": "<string>",
    "geoDivisionDisplayPath": "<string>",
    "addressLine": "<string>"
  },
  "shippingAddress": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "geoLevel1": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel2": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel3": {
      "name": "Miraflores",
      "code": "150122"
    },
    "geoLevel4": {
      "name": "Miraflores",
      "code": "150122"
    },
    "coordinates": {
      "latitude": -12.046374,
      "longitude": -77.042793
    },
    "recipientName": "<string>",
    "recipientPhone": "<string>",
    "instructions": "<string>",
    "customerAddressId": "<string>"
  },
  "payment": {
    "methodKind": "MANUAL",
    "methodName": "<string>",
    "paidVia": "CARD",
    "installments": 12,
    "installmentsInterest": "WITH_INTEREST",
    "reference": "<string>",
    "paidAt": "2026-06-30T14:12:00Z",
    "amountPaid": "1234.56"
  },
  "cancellation": {
    "reason": "<string>",
    "note": "<string>",
    "byMemberId": "<string>",
    "byName": "<string>"
  },
  "fulfillments": [
    {
      "carrier": "<string>",
      "trackingNumber": "<string>",
      "trackingUrl": "<string>",
      "preparingAt": "2026-06-30T14:12:00Z",
      "fulfilledAt": "2026-06-30T14:12:00Z",
      "deliveredAt": "2026-06-30T14:12:00Z"
    }
  ],
  "invoiceStatus": "NOT_INVOICED",
  "invoices": [
    {
      "id": "<string>",
      "number": "<string>",
      "issuedAt": "2026-06-30T14:12:00Z",
      "registeredAt": "2026-06-30T14:12:00Z"
    }
  ],
  "promotions": [
    {
      "id": "<string>",
      "code": "<string>",
      "title": "<string>",
      "class": "GOODS",
      "amount": "1234.56"
    }
  ],
  "items": [
    {
      "id": "<string>",
      "variantId": "<string>",
      "variantSku": "<string>",
      "productId": "<string>",
      "productName": "<string>",
      "productImageUrl": "<string>",
      "quantity": 2,
      "price": "1234.56",
      "listPrice": "1234.56",
      "discountTotal": "1234.56",
      "discountAllocations": [
        {
          "promotionId": "<string>",
          "amount": "1234.56"
        }
      ],
      "taxName": "<string>",
      "taxCode": "<string>",
      "taxRatePercent": "18.00",
      "subtotal": "1234.56",
      "taxTotal": "1234.56",
      "total": "1234.56",
      "components": [
        {
          "id": "<string>",
          "variantId": "<string>",
          "variantSku": "<string>",
          "productId": "<string>",
          "productName": "<string>",
          "quantityPerBundle": 3
        }
      ]
    }
  ],
  "transactions": [
    {
      "id": "<string>",
      "kind": "AUTHORIZATION",
      "status": "PENDING",
      "amount": "1234.56",
      "provider": "OPENPAY",
      "gatewayTransactionId": "<string>",
      "cardBrand": "<string>",
      "cardLast4": "<string>",
      "cardType": "CREDIT",
      "installments": 12,
      "installmentsInterest": "WITH_INTEREST",
      "authorizationCode": "<string>",
      "gatewayResultCode": "<string>",
      "errorCode": "<string>",
      "test": true,
      "processedAt": "2026-06-30T14:12:00Z",
      "createdAt": "2026-06-30T14:12:00Z"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Autorizaciones

Authorization

string

header

requerido

Public API key presented as Authorization: Bearer rq_live_….

Parámetros de ruta

string<uuid>

requerido

Ejemplo:

"0b2e9f5a-1c3d-4e6f-8a9b-0c1d2e3f4a5b"

Cuerpo

application/json

courierId

string<uuid> | null

UUID of one of the organization's couriers. Assigns it to the order; carrier then defaults to the courier's name and trackingUrl to its tracking URL template. An order whose courier the buyer chose at checkout keeps it: a different courierId or carrier fails with ROUTE_COURIER_LOCKED.

carrier

string | null

Carrier name. Required together with trackingNumber unless the order carries a courier, whose name is then used.

Required string length: 1 - 255

trackingNumber

string | null

Carrier tracking/guide number. Required together with carrier.

Required string length: 1 - 255

trackingUrl

string<uri> | null

URL to track the shipment. Optional.

Maximum string length: 2000

Respuesta

The updated order.

string

requerido

Order UUID. Stable primary key; use it for lookups.

code

string

requerido

Display code assigned at creation from the organization's configured prefix and padding (e.g. #1042, P001042). Never changes after creation.

status

enum<string>

requerido

Lifecycle status: PLACED, CANCELLED, or AWAITING_REVIEW — a credit order that exceeded the customer's available credit, held until the merchant approves it (then PLACED) or rejects it (then CANCELLED). An AWAITING_REVIEW order cannot be fulfilled, paid or invoiced.

Opciones disponibles:

AWAITING_REVIEW,

PLACED,

CANCELLED

paymentStatus

enum<string>

requerido

Payment state: UNPAID, PARTIALLY_PAID, PAID, PENDING (a charge attempt is open and resolving on its own), or ERROR (it never resolved; the merchant has to check the gateway).

Opciones disponibles:

UNPAID,

PARTIALLY_PAID,

PAID,

PENDING,

ERROR

fulfillmentStatus

enum<string>

requerido

Preparation state, forward-only: UNFULFILLED → IN_PROGRESS → FULFILLED → DELIVERED.

Opciones disponibles:

UNFULFILLED,

IN_PROGRESS,

FULFILLED,

DELIVERED

source

enum<string>

requerido

Channel the order came from (currently always STOREFRONT).

Opciones disponibles:

STOREFRONT,

PURCHASE_ORDER,

MIGRATION,

ASSISTED

createdAt

string

requerido

When the order record was created.

Ejemplo:

"2026-06-30T14:12:00Z"

updatedAt

string

requerido

When the order was last modified. Use as the watermark for incremental sync.

Ejemplo:

"2026-06-30T14:12:00Z"

placedAt

string | null

requerido

When the customer placed the order. Set by every placement path; null only on legacy rows.

Ejemplo:

"2026-06-30T14:12:00Z"

cancelledAt

string | null

requerido

When the order was cancelled. Null unless status is CANCELLED.

Ejemplo:

"2026-06-30T14:12:00Z"

placedAsGuest

boolean

requerido

The buyer had no session at placement. This is the guest signal — buyer.customerId is set either way.

comment

string | null

requerido

Free-text note the buyer wrote for the whole order at checkout. Distinct from shippingAddress.instructions (about the address) and cancellation.note (written by an operator). Null when none was given.

currencyCode

string

requerido

ISO 4217 currency code for all money fields.

Ejemplo:

"USD"

subtotal

string

requerido

Net of everything (goods + shipping), post-discount. Equals total − taxTotal. subtotal + taxTotal = total in both tax modes.

Ejemplo:

"1234.56"

taxTotal

string

requerido

Aggregate of all taxes on the order.

Ejemplo:

"1234.56"

taxLines

object[]

requerido

Per-rate breakdown of taxTotal: one entry per distinct tax rate on the order, shipping folded into the rate it was taxed at (the org default). Amounts sum to taxTotal; ordered by rate descending.

Show child attributes

shippingTotal

string

requerido

Shipping charge as the buyer saw it. Informational — already reflected in subtotal/total; not an addend.

Ejemplo:

"1234.56"

shippingTaxTotal

string

requerido

Tax on the shipping charge, at the org's default rate. Part of taxTotal; 0 on pickup or free shipping.

Ejemplo:

"1234.56"

discountTotal

string

requerido

Goods + order discount as the buyer saw it. Informational; not an addend. Shipping discounts surface as a reduced shippingTotal plus a SHIPPING promotion.

Ejemplo:

"1234.56"

total

string

requerido

Amount owed: subtotal + taxTotal.

Ejemplo:

"1234.56"

priceList

object | null

requerido

Price list that governed this order's prices, resolved from the buyer's commercial policy at placement and snapshotted. Null when no policy applied to the order.

Show child attributes

segment

object | null

requerido

Segment the buyer belonged to at placement, snapshotted: the individual's on a storefront order, the company's on a purchase order. Null for guests and buyers without a segment.

Show child attributes

location

object | null

requerido

Where the order is fulfilled from, whatever its shipping type: the point the buyer collects at on PICKUP, the dispatch origin on DELIVERY. Null when placement carried no fulfillment selection.

Show child attributes

shippingMethod

object

requerido

The shipping method snapshot. type is the delivery/pickup discriminator.

Show child attributes

courier

object | null

requerido

The transport company the order ships with, when the method offered couriers — decided by the buyer's branch pick at checkout, or assigned by the merchant at dispatch. Null on own-fleet deliveries and pickups.

Show child attributes

courierBranch

object | null

requerido

The courier office the buyer collects at (COURIER_PICKUP) or that does the last mile to shippingAddress (DELIVERY with a destination branch). Null otherwise.

Show child attributes

buyer

object

requerido

Who placed the order, as they identified themselves at checkout.

Show child attributes

billing

object | null

requerido

Invoicing details the buyer requested. Null when no invoice was requested. Distinct from buyer.documentType / buyer.documentNumber, which are the buyer's own ID.

Show child attributes

shippingAddress

object | null

requerido

Delivery address snapshot. Null on PICKUP and COURIER_PICKUP orders.

Show child attributes

payment

object

requerido

The method the buyer chose and what has been received against paymentStatus. Per-attempt gateway facts live in transactions.

Show child attributes

cancellation

object | null

requerido

Why and by whom the order was cancelled. Null unless status is CANCELLED.

Show child attributes

fulfillments

object[]

requerido

Shipments of the order — carrier, tracking and the timestamps behind fulfillmentStatus. Empty while the order is UNFULFILLED; currently at most one element, since an order is prepared and dispatched as a single shipment.

Show child attributes

invoiceStatus

enum<string>

requerido

Whether the order carries at least one registered fiscal document. Independent of status, paymentStatus, and fulfillmentStatus.

Opciones disponibles:

NOT_INVOICED,

INVOICED

invoices

object[]

requerido

Fiscal document references registered for the order, oldest first. Empty until invoiced; an order split across several facturas carries one element per document.

Show child attributes

promotions

object[]

requerido

Applied promotions on the order, including SHIPPING-class ones.

Show child attributes

items

object[]

requerido

Line items in the order, in stable display order. Array position is the line's order — there is no separate position field.

Show child attributes

transactions

object[]

requerido

Every gateway charge attempt on this order, oldest first — declines and errors included. Empty for orders paid without a gateway.

Show child attributes

Introducción

API

Temas

Mark delivered (or picked up)

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta