curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "[email protected]",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "[email protected]",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "[email protected]",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
}
},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
],
"shipments": [
{
"id": 123,
"sales_order_id": 123,
"ship_date": "2023-12-25",
"tracking_number": "<string>",
"bol_number": "BOL-123456789",
"pro_number": "PRO-987654321",
"partner_reference_number": "PARTNER-REF-001",
"is_return": true,
"carrier_code": "<string>",
"service_code": "<string>",
"package_code": "<string>",
"shipment_cost": 123,
"insurance_cost": 123,
"warehouse_id": 123,
"status": 123,
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"phone": "<string>",
"residential": true
},
"weight": {
"value": 123,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 123,
"width": 123,
"height": 123
},
"items": [
{
"id": 123,
"shipment_id": 123,
"product_id": 123,
"order_item_id": 123,
"quantity": 123,
"weight": {
"value": 123,
"units": "ounces"
},
"unit_price": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {}
}
}Get details of a specific sales order by ID
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "[email protected]",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "[email protected]",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "[email protected]",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
}
},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
],
"shipments": [
{
"id": 123,
"sales_order_id": 123,
"ship_date": "2023-12-25",
"tracking_number": "<string>",
"bol_number": "BOL-123456789",
"pro_number": "PRO-987654321",
"partner_reference_number": "PARTNER-REF-001",
"is_return": true,
"carrier_code": "<string>",
"service_code": "<string>",
"package_code": "<string>",
"shipment_cost": 123,
"insurance_cost": 123,
"warehouse_id": 123,
"status": 123,
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"phone": "<string>",
"residential": true
},
"weight": {
"value": 123,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 123,
"width": 123,
"height": 123
},
"items": [
{
"id": 123,
"shipment_id": 123,
"product_id": 123,
"order_item_id": 123,
"quantity": 123,
"weight": {
"value": 123,
"units": "ounces"
},
"unit_price": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {}
}
}Authenticate using a bearer token. To obtain a token, contact [email protected]
ID of the sales order to retrieve
Successful response
Show child attributes