Skip to content

Commit 725e33c

Browse files
committed
minor syntax cleanup
1 parent a2f807c commit 725e33c

2 files changed

Lines changed: 11 additions & 17 deletions

File tree

_snippets/_moving-fulfillment-orders.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@ Fulfillment Orders must be `"status": "open"` to be moved to a new location. If
2323
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.
2424

2525
```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
2928
{
3029
"available_locations": [
3130
{
@@ -52,8 +51,7 @@ GET https://{store}.29next.store/api/admin/fulfillment-orders/{id}/available-loc
5251
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.
5352

5453
```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/
5755
{
5856
"new_location_id": 123,
5957
/// optional, if not passed, all lines will be moved to the new location

docs/api/admin/guides/order-management.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ Order Refund Calculate APIs are only available on `2024-04-01` version and newer
4040
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.
4141

4242
```json title="Retrieve Order Details"
43-
GET https://{store}.29next.store/api/admin/orders/{number}/
44-
43+
//GET https://{store}.29next.store/api/admin/orders/{number}/
4544
{
4645
"lines": [
4746
{
@@ -61,8 +60,7 @@ Order payments must be captured in order to create partial refunds, uncaptured p
6160
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.
6261

6362
```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/
6664
{
6765
"refund_lines": [
6866
{
@@ -117,7 +115,7 @@ Below is the response from the [ordersRefundCalculateCreate](/docs/api/admin/ref
117115
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.
118116

119117
```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/
121119
{
122120
"note": "Example reason for the refund",
123121
"refund_lines": [
@@ -160,7 +158,6 @@ Updating an order shipping address is a common task that can be done with a PATC
160158

161159
```json title="Update Order Shipping Address"
162160
// PATCH https://{store}.29next.store/api/admin/orders/{number}/
163-
164161
{
165162
"shipping_address": {
166163
"line1": "4765 Test Lane West", // new shipping adddress line 1
@@ -208,12 +205,11 @@ stateDiagram-v2
208205
sendFulfillmentCancelRequest: Send Fulfillment Cancel Request
209206
retrieveFulfillmentOrders --> sendFulfillmentCancelRequest
210207
```
211-
- 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.
213210

214211
```json title="Hold Fulfillment Order Request"
215212
// POST https://{store}.29next.store/api/admin/fulfillment-orders/{id}/hold/
216-
217213
{
218214
"reason": "address_incorrect", // see available reasons in api reference
219215
"reason_message": "Additional relevant detail." // provide additional relevant detail
@@ -231,8 +227,9 @@ stateDiagram-v2
231227
sendFulfillmentCancelRequest: Send Fulfillment Cancel Request
232228
retrieveFulfillmentOrders --> sendFulfillmentCancelRequest
233229
```
234-
- 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.
236233

237234

238235
```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
257254

258255
```json title="Cacenl Order Request"
259256
// POST https://{store}.29next.store/api/admin/orders/{number}/cancel/
260-
261257
{
262258
"cancel_reason": "Customer wants to cancel", // Appropiate cancel reason message
263259
"full_refund": true, // Refund all remainaing payments or not

0 commit comments

Comments
 (0)