API Order - Revision history

Admin: /* Order Properties */

2026-01-22T01:37:10Z

Order Properties

Admin: /* Example Request and Response */

2025-11-21T03:44:08Z

Example Request and Response

Admin: /* Order Properties */

2025-11-21T03:42:08Z

Order Properties

Admin: /* PUT /api/orders/ORDER_ID/close.json */

2025-06-18T03:40:57Z

PUT /api/orders/ORDER_ID/close.json

Admin: /* Example Request and Response */

2025-06-18T03:39:46Z

Example Request and Response

Admin: /* POST /api/orders/ORDER_ID/ship.json */

2025-06-18T03:39:14Z

POST /api/orders/ORDER_ID/ship.json

Admin: /* POST /api/orders/ORDER_ID/ship.json */

2025-06-17T05:53:06Z

POST /api/orders/ORDER_ID/ship.json

Admin: /* Example Request and Response */

2025-06-17T05:52:12Z

Example Request and Response

Admin: /* POST /api/orders/ORDER_ID/ship.json */

2025-06-17T02:21:40Z

POST /api/orders/ORDER_ID/ship.json

Admin: /* Parameters */

2025-06-17T01:36:55Z

Parameters

@@ Line 3: / Line 3: @@
 == Order Properties ==
-{| class="reference"
+{| class="wikitable reference"
 !id
 |<code>{ "id" : 123456789 }</code><br/>
@@ Line 271: / Line 271: @@
 |-
 !line_items
-|<code>{ "line_items" : [<br/>&nbsp;&nbsp;{ "id": 1200,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"product_id": 1512,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"variation_id": 1705,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"product_exists": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"quantity": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"sku": "3445657",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"name": "Cute Dog - Brown",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"title": "Cute Dog",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"variation_title": "Brown",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"discount_description": <nowiki>"<br/>10% Off<br/>Wholesale"</nowiki>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"vendor": "Spiffy Stores",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"weight": 0.2,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"grams": 200.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"length": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"width": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"height": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"price": "19.99",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"wholesale_price": "9.99",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"taxable": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"discount_price": "3.8",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"total_price": "16.19",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"ship_separately": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"free_shipping": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"requires_shipping": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfilment_service": "manual",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfillable_quantity": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"shipping_method": "",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"instalments": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"gift_card": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfilment_status": null<br/>&nbsp;&nbsp;}<br/>] }</code><br/>
+|<code>{ "line_items" : [<br/>&nbsp;&nbsp;{ "id": 1200,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"product_id": 1512,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"variation_id": 1705,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"product_exists": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"quantity": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"sku": "3445657",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"name": "Cute Dog - Brown",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"title": "Cute Dog",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"variation_title": "Brown",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"discount_description": <nowiki>"<br/>10% Off<br/>Wholesale"</nowiki>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"vendor": "Spiffy Stores",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"weight": 0.2,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"grams": 200.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"length": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"width": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"height": 0.0,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"price": "19.99",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"wholesale_price": "9.99",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"taxable": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"discount_price": "3.8",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"total_price": "16.19",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"ship_separately": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"free_shipping": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"requires_shipping": true,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfilment_service": "manual",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfillable_quantity": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"shipping_method": "",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"instalments": 1,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"gift_card": false,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fulfilment_status": null,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"options": {<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Colour": "Brown",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Size": "Small",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Gift message": "Happy Birthday"<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>] }</code><br/>
 An array of <code>line_item</code> objects, containing information about the items that have been ordered. Each object has the following properties:
@@ Line 305: / Line 305: @@
 * gift_card - Indicates if the item is a gift card
 * fulfilment_status - Indicates the status of the fulfilment
 Items that are marked as gift cards are not taxed or included in any shipping charge calculations.

@@ Line 589: / Line 589: @@
        ],
        "shipping_lines": [],
        "discount_codes": []
      }, ...

@@ Line 93: / Line 93: @@
 ; SHIPPING_CODE
 :  The price for shipping is determined by the Shipping Code
 |-
 !surcharge_price

@@ Line 921: / Line 921: @@
 <pre>
 PUT /api/orders/16789/close.json
 HTTP/1.1 200 OK

← Older revision		Revision as of 03:39, 18 June 2025
Line 923:		Line 923:

	HTTP/1.1 200 OK		HTTP/1.1 200 OK
		+
		+	{
		+	"order":
		+	{
		+	"id": 16789,
		+	"order_number": 23543,
		+	"name": "#023543",
		+	"browser_ip": "127.0.0.1",
		+	"buyer_accepts_marketing": false,
		+	"cart_token": null,
		+	"created_at": "2015-02-27T18:08:33Z",
		+	"updated_at": "2015-02-27T18:08:33Z",
		+	...
		+	}
		+	}

	</pre>		</pre>

@@ Line 742: / Line 742: @@
 |-
 !carrier_code
-|Optionally, specify a carrier code for the shipment from the following list -
+|Optionally, specify a carrier code for the shipment from the following list below.
 |-
 !notify_customer
@@ Line 914: / Line 912: @@
    "count": 6
+}
 </pre>

← Older revision		Revision as of 05:53, 17 June 2025
Line 726:		Line 726:

	It is not necessary to ship all the items in an order, and the items in an order may be shipped either manually, via the API or by one of more fulfilment services.		It is not necessary to ship all the items in an order, and the items in an order may be shipped either manually, via the API or by one of more fulfilment services.
		+
		+	The number of items that have been marked as shipped is returned on a successful API call.

	==== Parameters ====		==== Parameters ====

← Older revision		Revision as of 05:52, 17 June 2025
Line 908:		Line 908:

	HTTP/1.1 201 Created		HTTP/1.1 201 Created
		+
		+	{
		+	"count": 6
		+	}
	</pre>		</pre>

@@ Line 724: / Line 724: @@
 This endpoint allows you to select line items and quantities from an order to be shipped. As with standard order processing, the order must be fully paid before any items can be shipped. The items selected to be shipped can only be items that have "manual" fulfilment, or items that have "default" fulfilment where no fulfilment service has been set as the default fulfilment service. This restriction exists to avoid any interference between API-initiated shipping versus the specialized shipping process required by a fulfilment service such as Australia Post's Parcel Contract or MyPost Business.
 ==== Parameters ====
@@ Line 733: / Line 735: @@
 !line_items
 |An array of items selecting the <code>line_item_id</code> and <code>quantity</code> to be shipped.
 |}