Order details

Returns full details for a single order. Requires admin scope.

GET/shops/{shop_id}/orders/{code}

Authorization

AuthorizationBearer token (JWT) · headerrequired

OAuth 2.0 Bearer token. Obtain via POST https://auth.onbolder.com/oauth/token.

Scopes:admin

Path parameters

shop_idstringrequired

Shop ID or subdomain

codestringrequired

Order code (e.g. R1C3964) or numeric ID

Responses

200

Order resource

idinteger

shop_idinteger

codestring

statusstring

Allowed:checkoutpendingclosedshippedinvalid

net_totalinteger

Order subtotal in cents (before shipping/discounts)

totalinteger

Final total in cents

shipping_totalinteger

shipping_descriptionstring

discount_totalinteger

tracking_codestring | null

courier_namestring | null

total_weight_in_gramsinteger

created_onstring<date-time>

updated_onstring<date-time>

pending_onstring<date-time> | null

closed_onstring<date-time> | null

shipped_onstring<date-time> | null

fulfillmentobject

Show properties

fulfillment_methodstring

Allowed:shippingpickup

payment_infoobject

Show properties

typestring

namestring

auth_codestring

transaction_idstring

_linksobject

_embeddedobject

Show properties

contactContactSummary

Show properties

idinteger

namestring

emailstring

phone_numberstring

addressAddress

Show properties

streetstring

street_2string

locality_namestring

region_namestring

country_namestring

country_codestring

postal_codestring | null

lat_longstring

Latitude,longitude pair

line_itemsLineItem[]

Show properties

Array of LineItem

product_idinteger

product_titlestring

unit_priceinteger

unitsinteger

discount_totalinteger

net_totalinteger

totalinteger

variant_idinteger

variant_titlestring

variant_skustring

weight_in_gramsinteger

promotionPromotion

Show properties

namestring

discountinteger

discount_typestring

Allowed:$%

free_shippingboolean

discountsobject[]

404

Resource not found

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*Shop ID or subdomaincodepath*Order code (e.g. `R1C3964`) or numeric ID

Request

curl -X GET 'https://api.onbolder.com/v1/shops/string/orders/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

response = requests.get(
    "https://api.onbolder.com/v1/shops/string/orders/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": 0,
  "shop_id": 0,
  "code": "string",
  "status": "checkout",
  "net_total": 0,
  "total": 0,
  "shipping_total": 0,
  "shipping_description": "string",
  "discount_total": 0,
  "tracking_code": "string",
  "courier_name": "string",
  "total_weight_in_grams": 0,
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "pending_on": "2019-08-24T14:15:22Z",
  "closed_on": "2019-08-24T14:15:22Z",
  "shipped_on": "2019-08-24T14:15:22Z",
  "fulfillment": {
    "fulfillment_method": "shipping"
  },
  "payment_info": {
    "type": "string",
    "name": "string",
    "auth_code": "string",
    "transaction_id": "string"
  },
  "_links": {},
  "_embedded": {
    "contact": {
      "id": 0,
      "name": "string",
      "email": "string",
      "phone_number": "string"
    },
    "address": {
      "street": "string",
      "street_2": "string",
      "locality_name": "string",
      "region_name": "string",
      "country_name": "string",
      "country_code": "string",
      "postal_code": "string",
      "lat_long": "string"
    },
    "line_items": [
      {
        "product_id": 0,
        "product_title": "string",
        "unit_price": 0,
        "units": 0,
        "discount_total": 0,
        "net_total": 0,
        "total": 0,
        "variant_id": 0,
        "variant_title": "string",
        "variant_sku": "string",
        "weight_in_grams": 0
      }
    ],
    "promotion": {
      "name": "string",
      "discount": 0,
      "discount_type": "$",
      "free_shipping": true
    },
    "discounts": [
      {}
    ]
  }
}

{
  "message": "string"
}