You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _snippets/_moving-fulfillment-orders.mdx
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,8 @@ Fulfillment Orders must be `"status": "open"` to be moved to a new location. If
23
23
Fulfillment order line items often contain products that are in stock at many locations where they could be fulfilled from. To check what locations fulfillment order items are available at, use the [availableLocationsRetrieve](/docs/api/admin/reference/#/operations/availableLocationsRetrieve) endpoint.
24
24
25
25
```json title="Retrieve Available Fulfillment Locations"
26
-
GET https://{store}.29next.store/api/admin/fulfillment-orders/{id}/available-locations/
27
-
28
-
// Example Response
26
+
// GET https://{store}.29next.store/api/admin/fulfillment-orders/{id}/available-locations/
27
+
// Response
29
28
{
30
29
"available_locations": [
31
30
{
@@ -52,8 +51,7 @@ GET https://{store}.29next.store/api/admin/fulfillment-orders/{id}/available-loc
52
51
Once the available locations fulfillment order line items can move, use the [fulfillmentOrdersMove](/docs/api/admin/reference/#/operations/fulfillmentOrdersMove) endpoint to move all or some of the line items.
53
52
54
53
```json title="Move Fulfillment Order Items to New Location"
55
-
POST https://{store}.29next.store/api/admin/fulfillment-orders/{id}/move/
56
-
54
+
// POST https://{store}.29next.store/api/admin/fulfillment-orders/{id}/move/
57
55
{
58
56
"new_location_id": 123,
59
57
/// optional, if not passed, all lines will be moved to the new location
Copy file name to clipboardExpand all lines: docs/api/admin/guides/order-management.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,7 @@ Order Refund Calculate APIs are only available on `2024-04-01` version and newer
40
40
Below is an abreviated example request to [ordersRetrieve](/docs/api/admin/reference/?v=2024-04-01#/operations/ordersRetrieve) endpoint to get the line items of the order.
41
41
42
42
```json title="Retrieve Order Details"
43
-
GET https://{store}.29next.store/api/admin/orders/{number}/
@@ -61,8 +60,7 @@ Order payments must be captured in order to create partial refunds, uncaptured p
61
60
Call the [ordersRefundCalculateCreate](/docs/api/admin/reference/?v=2024-04-01#/operations/ordersRefundCalculateCreate) endpoint with your line items to calculate the refund and see which initial payment transactions will be refunded.
62
61
63
62
```json title="Refund Calculate Request"
64
-
POST https://{store}.29next.store/api/admin/orders/{number}/refund/calculate/
65
-
63
+
// POST https://{store}.29next.store/api/admin/orders/{number}/refund/calculate/
66
64
{
67
65
"refund_lines": [
68
66
{
@@ -117,7 +115,7 @@ Below is the response from the [ordersRefundCalculateCreate](/docs/api/admin/ref
117
115
We're now ready to create a refund using the [ordersRefundCreate](/docs/api/admin/reference/?v=2024-04-01#/operations/ordersRefundCreate) endpoint, see request details below.
118
116
119
117
```json title="Order Create Refund Request"
120
-
POST https://{store}.29next.store/api/admin/orders/{number}/refund/
118
+
// POST https://{store}.29next.store/api/admin/orders/{number}/refund/
121
119
{
122
120
"note": "Example reason for the refund",
123
121
"refund_lines": [
@@ -160,7 +158,6 @@ Updating an order shipping address is a common task that can be done with a PATC
- Retrieve all fulfillment Orders using the [ordersFulfillmentOrdersRetrieve](/docs/api/admin/reference/#/operations/ordersFulfillmentOrdersRetrieve) endpoint.
212
-
- Send a [fulfillmentOrdersHold](/docs/api/admin/reference/#/operations/fulfillmentOrdersHold) request for each fulfillment order to hold.
208
+
1. Retrieve all fulfillment Orders using the [ordersFulfillmentOrdersRetrieve](/docs/api/admin/reference/#/operations/ordersFulfillmentOrdersRetrieve) endpoint.
209
+
2. Send a [fulfillmentOrdersHold](/docs/api/admin/reference/#/operations/fulfillmentOrdersHold) request for each fulfillment order to hold.
213
210
214
211
```json title="Hold Fulfillment Order Request"
215
212
// POST https://{store}.29next.store/api/admin/fulfillment-orders/{id}/hold/
216
-
217
213
{
218
214
"reason": "address_incorrect", // see available reasons in api reference
219
215
"reason_message": "Additional relevant detail."// provide additional relevant detail
- Retrieve all fulfillment Orders using the [ordersFulfillmentOrdersRetrieve](/docs/api/admin/reference/#/operations/ordersFulfillmentOrdersRetrieve) endpoint.
235
-
- Send a [cancellationRequestSend](/docs/api/admin/reference/#/operations/cancellationRequestSend) request for each fulfillment order to request fulfillment cancellation.
230
+
231
+
1. Retrieve all fulfillment Orders using the [ordersFulfillmentOrdersRetrieve](/docs/api/admin/reference/#/operations/ordersFulfillmentOrdersRetrieve) endpoint.
232
+
2. Send a [cancellationRequestSend](/docs/api/admin/reference/#/operations/cancellationRequestSend) request for each fulfillment order to request fulfillment cancellation.
236
233
237
234
238
235
```json titl="Fulfillment Order Cancellation Request"
@@ -257,7 +254,6 @@ Canceling an order is a common order management task when you need to cancel the
257
254
258
255
```json title="Cacenl Order Request"
259
256
// POST https://{store}.29next.store/api/admin/orders/{number}/cancel/
260
-
261
257
{
262
258
"cancel_reason": "Customer wants to cancel", // Appropiate cancel reason message
263
259
"full_refund": true, // Refund all remainaing payments or not
0 commit comments