Orders: Retrieve an order
GET /websites/:website_id/orders/:order_id
Get the details for an existing order by ID.
Attribute | Details |
---|---|
website_id
Required
integer
|
The ID of the website the order originated from. |
order_id
Required
integer
|
The ID of the order to be retrieved. |
includes
|
Comma separated list of additional fields to include in the response. Available includes are |
Sample Curl Request
curl "https://api.firespring.com/websites/4/orders/5894857" \ -u your-api-key: \ -H "Firespring-Api-Version: 1" \ -X GET \ -G \ -d includes="additional_information, billing_address, items.attributes, items.portal, items.print_ready_files, message, notes, payment_transactions, portal, promo_code, shipments.shipping_address, shipments.shipping_carrier, shipments.shipping_method, user"
Sample Response
{ "object": "order", "id": 5894857, "additional_information": { "object": "form_submission", "fields": { "f10119571": { "object": "form_submission_field", "id": "f10119571", "field_type": "text", "label": "Addition Information", "values": { "submitted_value": "" }, "formatted_value": "" } } }, "amount_paid": 5719, "billing_address": { "object": "form_submission", "fields": { "f10119137": { "object": "form_submission_field", "id": "f10119137", "field_type": "name", "label": "Your Name", "values": { "prefix": "", "first": "John", "middle": "", "last": "Doe", "suffix": "" }, "formatted_value": "John Doe" }, "f10119138": { "object": "form_submission_field", "id": "f10119138", "field_type": "text", "label": "Company", "values": { "submitted_value": "XYZ Corporation" }, "formatted_value": "XYZ Corporation" }, "f10119650": { "object": "form_submission_field", "id": "f10119650", "field_type": "address", "label": "Address", "values": { "line": "3232 Corporation Street", "line2": "", "line3": "", "city": "Lincoln", "state": "NE", "postal_code": "68516", "country": "US" }, "formatted_value": "3232 Corporation Street, Lincoln, NE, 68516, US" }, "f10119145": { "object": "form_submission_field", "id": "f10119145", "field_type": "email", "label": "Email", "values": { "submitted_value": "john.doe@xyzcorp.com", "display_value": "" }, "formatted_value": "john.doe@xyzcorp.com" }, "f10119146": { "object": "form_submission_field", "id": "f10119146", "field_type": "phone", "label": "Telephone", "values": { "country_code": "", "number": "1112222202", "extension": "" }, "formatted_value": "+1 1112222202" }, "f10119147": { "object": "form_submission_field", "id": "f10119147", "field_type": "text", "label": "Fax", "values": { "submitted_value": "" }, "formatted_value": "" } } }, "content_catalog": 10119035, "currency": "usd", "date_created": "2018-05-31T15:33:38+00:00", "is_pay_later": false, "items": { "object": "list", "data": [ { "object": "order_item", "id": 6, "attributes": { "object": "form_submission", "fields": { "f10119560": { "object": "order_item_attribute", "id": "f10119560", "field_type": "radio_buttons", "label": "Color", "values": { "submitted_value": "Blue", "display_value": "" }, "formatted_value": "Blue", "price_modifier": 0, "price_modifier_type": "percent", "price_scope": "all_units" } } }, "catalog_item": 379013, "content_catalog": 10119035, "date_created": "2018-05-31T15:33:38+00:00", "description": "Ballpoint pens have smooth-flowing ink that makes writing even, smooth and clear. These disposable pens offer 40 percent longer writing life without messy refills.", "exempt_from_shipping": false, "is_taxable": true, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "pricing": { "object": "order_item_pricing", "unit": 1995, "volume": 1995, "subtotal": 5985 }, "quantity": 3, "shipment": 14354, "short_description": "Ballpoint Pens", "sku": "PEN-001", "status": "ordered", "tax_class": 91442, "tax_percentage": 0.072, "title": "Pens", "weight": 1.1 }, { "object": "versadoc_order_item", "id": 7, "attributes": null, "catalog_item": 453454, "content_catalog": 10119035, "date_created": "2018-05-31T15:33:38+00:00", "description": "", "exempt_from_shipping": false, "is_taxable": false, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "pricing": { "object": "order_item_pricing", "unit": 0, "volume": 0, "subtotal": 0 }, "print_ready_files": { "object": "list", "data": [ { "object": "print_ready_file", "id": 2, "date_created": "2018-05-31T15:33:38+00:00", "tag": "#a6713581-ec0f-4285-a660-b60039d6260e - Business Card - PDF", "status": "success", "file": { "object": "file", "id": 8425952, "filename": "A3459843.zip", "url": "http://example-website-domain.com/file_download/47f48556-eff0-46a7-9969-62a20d969e743", "expires": "2018-06-30T15:33:38+00:00" } }, { "object": "print_ready_file", "id": 1, "date_created": "2018-04-27T13:13:21+00:00", "tag": "#a6713581-ec0f-4285-a660-b60039d6260e - Business Card - JPEG", "status": "failure", "file": null } ] }, "quantity": 1, "shipment": 14354, "short_description": "", "sku": "BC-001", "status": "ordered", "tax_class": 0, "tax_percentage": 0, "title": "Business Cards", "versadoc_order_form": { "object": "form_submission", "fields": { "f10119638": { "object": "form_submission_field", "id": "f10119638", "field_type": "text", "label": "Your Name", "values": { "submitted_value": "John Doe" }, "formatted_value": "John Doe" }, "f10119639": { "object": "form_submission_field", "id": "f10119638", "field_type": "text", "label": "Title", "values": { "submitted_value": "Project Manager" }, "formatted_value": "Project Manager" } } }, "weight": 1.1 } ] }, "message": { "object": "message", "id": 52, "date_created": "2018-05-31T15:33:38+00:00", "message_type": "online_order", "message_tracking_number": "a6713581-ec0f-4285-a660-b60039d6260e", "form": 0, "user": 11, "portal": 0, "file": 0, "online_proof": 0, "order": 5894857, "event_submission": 0 }, "notes": { "object": "list", "data": [ { "object": "order_note", "id": 1, "date_created": "2018-05-31T16:23:34+00:00", "note": "This is a test note.", "user": { "object": "account_user", "id": 1, "username": "admin" } } ] }, "order_type": "ecommerce", "payment_transactions": { "object": "list", "data": [ { "object": "payment_transaction", "id": 453454, "amount": 5719, "currency": "usd", "date_created": "2018-05-31T15:33:38+00:00", "is_recurring": false, "payment_type": "credit_card", "test_mode": false, "transaction_id": "09a3dc19d8924da88d391d8cb78a7988", "transaction_status": "captured", "transaction_type": "payment" } ] }, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "pricing": { "object": "order_pricing", "shipping": 500, "shipping_discount": 0, "subtotal": 5985, "subtotal_discount": 1197, "tax": 431, "total": 5719 }, "promo_code": { "object": "order_promo_code", "id": 2, "promo_code": { "object": "promo_code", "id": 3, "promo_code": "save20" }, "shipping_discount": 0, "subtotal_discount": 1197 }, "shipments": { "object": "list", "data": [ { "object": "order_shipment", "id": 14354, "date_created": "2018-05-31T15:33:38+00:00", "date_shipped": "2018-06-04T10:43:38+00:00", "shipping_address": { "object": "form_submission", "fields": { "f10119137": { "object": "form_submission_field", "id": "f10119137", "field_type": "name", "label": "Your Name", "values": { "prefix": "", "first": "John", "middle": "", "last": "Doe", "suffix": "" }, "formatted_value": "John Doe" }, "f10119138": { "object": "form_submission_field", "id": "f10119138", "field_type": "text", "label": "Company", "values": { "submitted_value": "XYZ Corporation" }, "formatted_value": "XYZ Corporation" }, "f10119650": { "object": "form_submission_field", "id": "f10119650", "field_type": "address", "label": "Address", "values": { "line": "3232 Corporation Street", "line2": "", "line3": "", "city": "Lincoln", "state": "NE", "postal_code": "68516", "country": "US" }, "formatted_value": "3232 Corporation Street, Lincoln, NE, 68516, US" }, "f10119145": { "object": "form_submission_field", "id": "f10119145", "field_type": "email", "label": "Email", "values": { "submitted_value": "john.doe@xyzcorp.com", "display_value": "" }, "formatted_value": "john.doe@xyzcorp.com" }, "f10119146": { "object": "form_submission_field", "id": "f10119146", "field_type": "phone", "label": "Telephone", "values": { "country_code": "", "number": "1112222202", "extension": "" }, "formatted_value": "+1 1112222202" }, "f10119147": { "object": "form_submission_field", "id": "f10119147", "field_type": "text", "label": "Fax", "values": { "submitted_value": "" }, "formatted_value": "" } } }, "shipping_carrier": { "object": "shipping_carrier", "id": 4364, "carrier_type": "custom", "title": "Test Shipping Carrier" }, "shipping_method": { "object": "shipping_method", "id": 46686, "title": "Test Shipping Method" }, "shipping_notification_sent": false, "status": "shipped", "tracking_number": "48307549475034", "price": 500 } ] }, "shipping_tax_percentage": 0, "status": "new", "user": { "object": "website_user", "id": 11, "third_party_identifier": "", "username": "xyzcorp" } }
Sample Curl Request
curl "https://api.firespring.com/websites/4/orders/4534" \ -u your-api-key: \ -H "Firespring-Api-Version: 1" \ -X GET \ -G \ -d includes="items.attributes, items.portal, message, payment_transactions, portal, promo_code, user"
Sample Response
{ "object": "order", "id": 4534, "amount_paid": 15960, "content_catalog": 10119035, "currency": "usd", "date_created": "2018-06-01T17:45:34+00:00", "is_pay_later": false, "items": { "object": "list", "data": [ { "object": "order_item", "id": 34, "attributes": { "object": "form_submission", "fields": { "f10119560": { "object": "order_item_attribute", "id": "f10119560", "field_type": "radio_buttons", "label": "Color", "values": { "submitted_value": "Black", "display_value": "" }, "formatted_value": "Black", "price_modifier": 0, "price_modifier_type": "percent", "price_scope": "all_units" } } }, "catalog_item": 379013, "content_catalog": 10119035, "date_created": "2018-06-01T17:45:34+00:00", "description": "Ballpoint pens have smooth-flowing ink that makes writing even, smooth and clear. These disposable pens offer 40 percent longer writing life without messy refills.", "exempt_from_shipping": false, "is_taxable": true, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "pricing": { "object": "order_item_pricing", "unit": 1995, "volume": 1995, "subtotal": 19950 }, "quantity": 10, "shipment": 675, "short_description": "Ballpoint Pens", "sku": "PEN-001", "status": "ordered", "tax_class": 4534, "tax_percentage": 0, "title": "Pens", "weight": 1.1 } ] }, "message": { "object": "message", "id": 52, "date_created": "2018-06-01T17:45:34+00:00", "message_type": "online_order", "message_tracking_number": "4354fjsldi930g", "form": 10119026, "user": 11, "portal": 1147329, "file": 0, "online_proof": 0, "order": 4534, "event_submission": 0 }, "order_type": "catalog", "payment_transactions": { "object": "list", "data": [ { "object": "payment_transaction", "id": 3423, "amount": 15960, "currency": "usd", "date_created": "2018-06-01T17:45:34+00:00", "is_recurring": false, "payment_type": "credit_card", "test_mode": false, "transaction_id": "409860394asdl48902kldklf93kd", "transaction_status": "captured", "transaction_type": "payment" } ] }, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "pricing": { "object": "order_pricing", "shipping": 0, "shipping_discount": 0, "subtotal": 19950, "subtotal_discount": 3990, "tax": 0, "total": 15960 }, "promo_code": { "object": "order_promo_code", "id": 2, "promo_code": { "object": "promo_code", "id": 3, "promo_code": "save20" }, "shipping_discount": 0, "subtotal_discount": 3990 }, "shipping_tax_percentage": 0, "status": "new", "user": { "object": "website_user", "id": 11, "third_party_identifier": "", "username": "xyzcorp" } }