v2.orders

Retrieve a v2 Order

get/orders/{id}

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/orders/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Cooud order id.

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

One order scoped to the bearer token's store binding.

billing_reasonstring required
countrystring nullable required
createdinteger required
currencystring required
customer_emailstring nullable required
customer_idstring required
effective_statusunknown required
exchange_ratenumber nullable required
fee_amountinteger required
has_upsell_itemboolean
idstring required
metadataobject
net_amountinteger required
object'order' required
order_typestring
presentment_amountinteger nullable required
presentment_currencystring nullable required
refunded_amountinteger required
request_idstring

Present on GET /v2/orders/{id}. Items of a V2OrderList do not carry it: the list has its own request_id.

risk_levelstring nullable required
risk_scorenumber nullable required
shipping_addressobject nullable required
splitsobject[]
statusstring required
store_idstring required
subscription_idstring nullable required

Stable public subscription id, shared with /subscriptions and webhook data.subscription; null for one-time purchases.

total_amountinteger required
stripe_platform'br' | 'us'

Present only on orders of Cooud LLC accounts: us when Cooud LLC charged the order, br when Cooud Brasil did. Orders of Cooud Brasil accounts do not carry it.

payment_method_typestring nullable

Present only on orders of Cooud LLC accounts: the payment method type the buyer paid with (for example card, oxxo, us_bank_account), null until the order is paid. Orders of Cooud Brasil accounts do not carry it.

Changes

No recorded changes to this operation across all 1 revision of this API.