curl --request POST \
--url https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start', 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/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/start")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"status": "PLACED",
"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>"
},
"location": {
"id": "<string>",
"name": "<string>"
},
"shippingMethod": {
"id": "<string>",
"type": "DELIVERY",
"label": "<string>"
},
"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>"
}
}Start preparation
Advance the order to IN_PROGRESS. Requires the fulfillment:write scope.
curl --request POST \
--url https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start', 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/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/start")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.riqra.com/public/v1/orders/{id}/fulfillment/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"status": "PLACED",
"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>"
},
"location": {
"id": "<string>",
"name": "<string>"
},
"shippingMethod": {
"id": "<string>",
"type": "DELIVERY",
"label": "<string>"
},
"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>"
}
}Autorizaciones
Public API key presented as Authorization: Bearer rq_live_….
Parámetros de ruta
"0b2e9f5a-1c3d-4e6f-8a9b-0c1d2e3f4a5b"
Respuesta
The updated order.
Order UUID. Stable primary key; use it for lookups.
Display code assigned at creation from the organization's configured prefix and padding (e.g. #1042, P001042). Never changes after creation.
Lifecycle status: PLACED or CANCELLED.
PLACED, CANCELLED 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).
UNPAID, PARTIALLY_PAID, PAID, PENDING, ERROR Preparation state, forward-only: UNFULFILLED → IN_PROGRESS → FULFILLED → DELIVERED.
UNFULFILLED, IN_PROGRESS, FULFILLED, DELIVERED Channel the order came from (currently always STOREFRONT).
STOREFRONT, PURCHASE_ORDER, MIGRATION When the order record was created.
"2026-06-30T14:12:00Z"
When the order was last modified. Use as the watermark for incremental sync.
"2026-06-30T14:12:00Z"
When the customer placed the order. Set by every placement path; null only on legacy rows.
"2026-06-30T14:12:00Z"
When the order was cancelled. Null unless status is CANCELLED.
"2026-06-30T14:12:00Z"
The buyer had no session at placement. This is the guest signal — buyer.customerId is set either way.
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.
ISO 4217 currency code for all money fields.
"USD"
Net of everything (goods + shipping), post-discount. Equals total − taxTotal. subtotal + taxTotal = total in both tax modes.
"1234.56"
Aggregate of all taxes on the order.
"1234.56"
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
Show child attributes
Shipping charge as the buyer saw it. Informational — already reflected in subtotal/total; not an addend.
"1234.56"
Tax on the shipping charge, at the org's default rate. Part of taxTotal; 0 on pickup or free shipping.
"1234.56"
Goods + order discount as the buyer saw it. Informational; not an addend. Shipping discounts surface as a reduced shippingTotal plus a SHIPPING promotion.
"1234.56"
Amount owed: subtotal + taxTotal.
"1234.56"
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
Show child attributes
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
Show child attributes
The shipping method snapshot. type is the delivery/pickup discriminator.
Show child attributes
Show child attributes
Who placed the order, as they identified themselves at checkout.
Show child attributes
Show child attributes
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
Show child attributes
Delivery address snapshot. Null on PICKUP orders.
Show child attributes
Show child attributes
The method the buyer chose and what has been received against paymentStatus. Per-attempt gateway facts live in transactions.
Show child attributes
Show child attributes
Why and by whom the order was cancelled. Null unless status is CANCELLED.
Show child attributes
Show child attributes
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
Show child attributes
Whether the order carries at least one registered fiscal document. Independent of status, paymentStatus, and fulfillmentStatus.
NOT_INVOICED, INVOICED 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
Show child attributes
Applied promotions on the order, including SHIPPING-class ones.
Show child attributes
Show child attributes
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
Show child attributes
Every gateway charge attempt on this order, oldest first — declines and errors included. Empty for orders paid without a gateway.
Show child attributes
Show child attributes