Get Order
curl --request GET \
--url https://api.launchmystore.io/api/v1/orders/:id.json \
--header 'Authorization: Bearer <token>'{
"success": true,
"data": {
"id": "<string>",
"order_number": 123,
"email": "<string>",
"phone": "<string>",
"status": "<string>",
"financial_status": "<string>",
"fulfillment_status": "<string>",
"currency": "<string>",
"subtotal_price": 123,
"total_tax": 123,
"total_shipping": 123,
"total_discounts": 123,
"total_price": 123,
"line_items": [
{}
],
"customer": {},
"shipping_address": {},
"billing_address": {},
"fulfillments": [
{}
],
"refunds": [
{}
],
"discount_codes": [
{}
],
"note": "<string>",
"note_attributes": [
{}
],
"tags": [
{}
],
"created_at": "<string>",
"updated_at": "<string>",
"closed_at": "<string>",
"cancelled_at": "<string>"
}
}Orders
Get Order
Retrieve a single order by ID
GET
/
api
/
v1
/
orders
/
:id.json
Get Order
curl --request GET \
--url https://api.launchmystore.io/api/v1/orders/:id.json \
--header 'Authorization: Bearer <token>'{
"success": true,
"data": {
"id": "<string>",
"order_number": 123,
"email": "<string>",
"phone": "<string>",
"status": "<string>",
"financial_status": "<string>",
"fulfillment_status": "<string>",
"currency": "<string>",
"subtotal_price": 123,
"total_tax": 123,
"total_shipping": 123,
"total_discounts": 123,
"total_price": 123,
"line_items": [
{}
],
"customer": {},
"shipping_address": {},
"billing_address": {},
"fulfillments": [
{}
],
"refunds": [
{}
],
"discount_codes": [
{}
],
"note": "<string>",
"note_attributes": [
{}
],
"tags": [
{}
],
"created_at": "<string>",
"updated_at": "<string>",
"closed_at": "<string>",
"cancelled_at": "<string>"
}
}Get Order
Returns a single order with full details including line items, customer information, and fulfillment data.Request
curl -X GET "https://api.launchmystore.io/api/v1/orders/ord_abc123.json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Parameters
The unique order ID
Comma-separated list of fields to include in the response
Response
Whether the request succeeded
The order object
Show Order Object
Show Order Object
Unique order ID
Human-readable order number
Customer email
Customer phone number
Order status:
pending, confirmed, fulfilled, cancelled, refundedPayment status:
pending, paid, partially_paid, refunded, partially_refundedFulfillment status:
unfulfilled, partial, fulfilledOrder currency code (ISO 4217)
Subtotal in cents (before tax and shipping)
Total tax amount in cents
Total shipping cost in cents
Total discounts applied in cents
Final total in cents
Array of order line items
Customer information
Shipping address details
Billing address details
Array of fulfillment records
Array of refund records
Applied discount codes
Order notes from customer
Additional order attributes
Order tags
Creation timestamp (ISO 8601)
Last update timestamp (ISO 8601)
Closure timestamp (ISO 8601), if order is closed
Cancellation timestamp (ISO 8601), if order was cancelled
Example Response
{
"success": true,
"data": {
"id": "ord_abc123",
"order_number": 1001,
"email": "customer@example.com",
"phone": "+1-555-123-4567",
"status": "confirmed",
"financial_status": "paid",
"fulfillment_status": "unfulfilled",
"currency": "USD",
"subtotal_price": 5000,
"total_tax": 450,
"total_shipping": 500,
"total_discounts": 500,
"total_price": 5450,
"line_items": [
{
"id": "li_xyz789",
"product_id": "prod_abc123",
"variant_id": "var_xyz789",
"title": "Classic T-Shirt",
"variant_title": "Small / Black",
"quantity": 2,
"price": 2500,
"total": 5000,
"sku": "TSHIRT-S-BLK",
"requires_shipping": true,
"taxable": true,
"fulfillment_status": null,
"properties": []
}
],
"customer": {
"id": "cust_123",
"email": "customer@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+1-555-123-4567",
"orders_count": 5,
"total_spent": 25000
},
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"company": "Acme Inc",
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"province": "NY",
"province_code": "NY",
"country": "United States",
"country_code": "US",
"zip": "10001",
"phone": "+1-555-123-4567"
},
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"address1": "123 Main St",
"city": "New York",
"province": "NY",
"country": "United States",
"country_code": "US",
"zip": "10001"
},
"fulfillments": [],
"refunds": [],
"discount_codes": [
{
"code": "SAVE10",
"amount": 500,
"type": "fixed_amount"
}
],
"note": "Please leave at the door",
"note_attributes": [],
"tags": ["VIP", "first-order"],
"created_at": "2024-01-20T14:30:00Z",
"updated_at": "2024-01-20T14:35:00Z",
"closed_at": null,
"cancelled_at": null
}
}
Error Codes
| Code | Description |
|---|---|
UNAUTHORIZED | Invalid or missing access token |
FORBIDDEN | App doesn’t have read_orders scope |
NOT_FOUND | Order with the specified ID does not exist |
⌘I