Get an order

Direct access to an order by ID or permalink. No shop_id needed in the URL — authorization is verified via the token’s account ownership.

GET/orders/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Order ID or permalink

Responses

200Order entity

_linksHalLinks

idinteger

shop_idinteger

codestring

Order code, used as the path identifier (e.g. `/v2/orders/{code}`)

external_idstring | null

Optional client-supplied reference, unique per seller. Set it at create time (or via update) to look the order back up later with `GET /v2/orders?external_id={value}` — unlike `id`/`code`, a colliding `external_id` is rejected with a 422 instead of being silently reassigned, so it's safe to use for dedup checks before retrying a create.

statusstring

Allowed:draftcheckoutin_reviewpendingcancelledclosedcompleted

fulfillment_statusstring

Allowed:nonequeuedpreparingreadyshippeddeliveredreturned

checkout_urlstring

Present only when the order is in `checkout` or `pending` status

archivedboolean

currency_codestring

prices_include_taxboolean

items_net_totalinteger

Line items subtotal in cents, before discounts

items_discount_totalinteger

items_totalinteger

Line items subtotal in cents, after discounts

net_totalinteger

Order total in cents before tax

discount_totalinteger

cart_totalinteger

surcharge_totalinteger

shipping_totalinteger

shipping_discountinteger

shipping_minus_discountinteger

tax_ratenumber

Present only when `prices_include_tax` is false

tax_totalinteger

Present only when `prices_include_tax` is false

totalinteger

Grand total in cents, including shipping, discounts and tax

total_paidinteger

total_refundedinteger

max_refundable_amountinteger

partial_payment_offeredboolean

Whether this order is eligible for buyer-chosen partial payment: either the shop has it enabled for everyone, or this specific order was offered it via the API (`partial_payment_offered: true` on create/update). Either way, the order must not require review and any configured cart requirements must be met. Normally also requires a token-based payment method to exist, so the balance can be auto-charged later - unless the shop allows manual (non-token) payment methods for this, in which case the balance is instead collected via a reminder email. Only present when fetching a single order, not in list results.

paying_partiallyboolean

Whether the buyer opted into a partial payment for this order.

partial_payment_percentageinteger

Percentage of the total charged upfront. Only present when `paying_partially` is true.

partial_payment_amountnumber

Amount charged upfront, in cents. Only present when fetching a single order, and only when partial payment is offered or active.

partial_payment_due_onstring<date>

Date the remaining balance is due. Only present when `paying_partially` is true.

shipping_descriptionstring

tracking_codestring

courier_namestring

payment_infoobject

Present only when the order has an associated payment method.

Show properties

idinteger

namestring

typestring

Payment method type/gateway identifier (e.g. `webpay_rest`, `mercado_pago`).

dataobject

Gateway-specific transaction data, shape varies by `type`.

requested_document_typestring

Tax document type requested by the buyer at checkout (e.g. `invoice`, `receipt`), if any. Derived from custom order data, not a plain column.

tagsstring[]

tag_idsinteger[]

allowed_statusesstring[]

allowed_fulfillment_statusesstring[]

created_onstring<date-time>

updated_onstring<date-time>

checkout_onstring<date-time> | null

pending_onstring<date-time> | null

closed_onstring<date-time> | null

shipped_onstring<date-time> | null

_embeddedobject

`contact` is present when the order has a customer attached. `company` is present when a company/tax entity is attached (e.g. via `company_name` on create/update). `address`/`billing_address` are present when set. `line_items` is always present. `payments`/`refunds`/`documents` are present only when non-empty.

Show properties

contactobject

Show properties

idinteger

namestring

emailstring

phone_numberstring

companyobject

Show properties

idinteger

namestring

id_numberstring

Formatted tax/ID number (RUT, DNI, etc.)

activity_codestring

addressAddress

Show properties

streetstring

street_2string

locality_namestring

region_namestring

country_namestring

postal_codestring

addressAddress

Show properties

streetstring

street_2string

locality_namestring

region_namestring

country_namestring

postal_codestring

billing_addressAddress

Show properties

streetstring

street_2string

locality_namestring

region_namestring

country_namestring

postal_codestring

line_itemsobject[]

Show properties

Array of object

idinteger

product_idinteger

product_namestring

variant_idinteger

variant_namestring

variant_skustring

unitsinteger

unit_priceinteger

Unit price in cents

net_totalinteger

Line total in cents before discounts

totalinteger

Line total in cents after discounts/surcharges

paymentsOrderTransaction[]

Show properties

Array of OrderTransaction

idinteger

order_idinteger

amountinteger

Amount in cents (negative for refunds)

absolute_amountinteger

Absolute value of `amount` in cents

successfulboolean

card_token_idinteger

payment_method_typestring

transaction_idstring

Gateway transaction ID

authorization_codestring

descriptionstring

created_atstring<date-time>

refundsOrderTransaction[]

Show properties

Array of OrderTransaction

idinteger

order_idinteger

amountinteger

Amount in cents (negative for refunds)

absolute_amountinteger

Absolute value of `amount` in cents

successfulboolean

card_token_idinteger

payment_method_typestring

transaction_idstring

Gateway transaction ID

authorization_codestring

descriptionstring

created_atstring<date-time>

documentsOrderDocument[]

Show properties

Array of OrderDocument

idinteger

document_typestring

Allowed:invoicereceipt

document_numberstring

file_urlstring

403Order belongs to a different account

404Order not found

Request

curl -X GET "https://api.onbolder.com/v2/orders/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.onbolder.com/v2/orders/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/orders/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": 5001,
  "shop_id": 1,
  "code": "ORD-5001",
  "status": "pending",
  "fulfillment_status": "none",
  "currency_code": "USD",
  "total": 8499,
  "total_paid": 8499,
  "created_on": "2024-06-15T09:45:00Z",
  "updated_on": "2024-06-15T09:45:00Z",
  "_embedded": {
    "contact": {
      "id": 42,
      "name": "Jane Doe",
      "email": "customer@example.com",
      "phone_number": "+15551234567"
    },
    "line_items": [
      {
        "id": 9001,
        "product_id": 101,
        "product_name": "T-Shirt",
        "variant_id": 201,
        "variant_name": "Medium / Blue",
        "units": 2,
        "unit_price": 2500,
        "net_total": 5000,
        "total": 5000
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/orders/ORD-5001"
    },
    "orders:update": {
      "href": "https://api.onbolder.com/v2/orders/ORD-5001",
      "method": "put"
    },
    "shops:show": {
      "href": "https://api.onbolder.com/v2/shops/1"
    }
  }
}