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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ stateDiagram-v2
11
11
availableLocations --> moveItems
12
12
```
13
13
Moving fulfillment order items is a 2-step process:
14
-
1. Retrieve available locations for items to move using the [availableLocationsRetrieve](/docs/api/admin/reference/#/operations/availableLocationsRetrieve) endpoint.
15
-
2. Move fulfilllment order line items to a new location using the [fulfillmentOrdersMove](/docs/api/admin/reference/#/operations/fulfillmentOrdersMove) endpoint.
14
+
1. Retrieve available locations for items to move using the [availableLocationsRetrieve](/docs/admin-api/reference/#/operations/availableLocationsRetrieve) endpoint.
15
+
2. Move fulfilllment order line items to a new location using the [fulfillmentOrdersMove](/docs/admin-api/reference/#/operations/fulfillmentOrdersMove) endpoint.
16
16
17
17
:::info
18
-
Fulfillment Orders must be `"status": "open"` to be moved to a new location. If the fulfillment order you want to move is `"status": "processing"`, use the [cancellationRequestSend](/docs/api/admin/reference/#/operations/cancellationRequestSend) endpoint to request cancellation with the current fulfillment location before moving to a new location.
18
+
Fulfillment Orders must be `"status": "open"` to be moved to a new location. If the fulfillment order you want to move is `"status": "processing"`, use the [cancellationRequestSend](/docs/admin-api/reference/#/operations/cancellationRequestSend) endpoint to request cancellation with the current fulfillment location before moving to a new location.
19
19
:::
20
20
21
21
#### Retrieve Available Locations
22
22
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.
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/admin-api/reference/#/operations/availableLocationsRetrieve) endpoint.
24
24
25
25
```json title="Retrieve Available Fulfillment Locations"
26
26
// GET https://{store}.29next.store/api/admin/fulfillment-orders/{id}/available-locations/
@@ -48,7 +48,7 @@ Fulfillment order line items often contain products that are in stock at many lo
48
48
49
49
#### Move a Fulfillment Order
50
50
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.
51
+
Once the available locations fulfillment order line items can move, use the [fulfillmentOrdersMove](/docs/admin-api/reference/#/operations/fulfillmentOrdersMove) endpoint to move all or some of the line items.
52
52
53
53
```json title="Move Fulfillment Order Items to New Location"
54
54
// POST https://{store}.29next.store/api/admin/fulfillment-orders/{id}/move/
Copy file name to clipboardExpand all lines: docs/admin-api/guides/external-checkout.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,11 +58,11 @@ Carts are the starting point for all orders, carts are essentially draft orders
58
58
:::info Notes
59
59
- The carts create API accepts a user object that will `get or create` the user by their email address making it is safe to use for both new and existing users.
60
60
- Attribution added to a cart is carried over to the Orders and Subscriptions created on the users next order, you do not need to pass this data on the order request.
61
-
- If you need to capture an address with the cart, use the [usersAddressesCreate](/docs/api/admin/reference/#/operations/usersAddressesCreate) endpoint which will create a default address for the user.
61
+
- If you need to capture an address with the cart, use the [usersAddressesCreate](/docs/admin-api/reference/#/operations/usersAddressesCreate) endpoint which will create a default address for the user.
62
62
:::
63
63
64
64
### Create Order
65
-
Creating an order is the core resource in an external checkout flow, see the example below to familiarize yourself with the [ordersCreate](/docs/api/admin/reference/#/operations/ordersCreate) API endpoint.
65
+
Creating an order is the core resource in an external checkout flow, see the example below to familiarize yourself with the [ordersCreate](/docs/admin-api/reference/#/operations/ordersCreate) API endpoint.
66
66
67
67
```json title="Request"
68
68
// POST https://{store}.29next.store/api/admin/orders/
@@ -103,12 +103,12 @@ Creating an order is the core resource in an external checkout flow, see the exa
103
103
- Attribution detail are not necessary if you have already added it to the users active cart.
104
104
-`shipping_code` and `shipping_price` are optional parameters you can set to specify the shipping method and shipping price.
105
105
- If you already created an address for the user, pass `use_default_shipping_address` and `use_default_billing_address` as true to use their default address for the order.
106
-
- For additional payment methods, see our guides on [Card Tokenization](/docs/api/admin/guides/iframe-payment-form.md), [3DS2](/docs/api/admin/guides/3ds2.md), [Apple Pay](/docs/api/admin/guides/apple-pay.md), [PayPal](/docs/api/admin/guides/paypal.md), [Klarna](/docs/api/admin/guides/klarna.md), [Twint](/docs/api/admin/guides/twint.md), [Bancontact](/docs/api/admin/guides/bancontact.md), and [SEPA](/docs/api/admin/guides/sepa-debit.md).
106
+
- For additional payment methods, see our guides on [Card Tokenization](/docs/admin-api/guides/iframe-payment-form.md), [3DS2](/docs/admin-api/guides/3ds2.md), [Apple Pay](/docs/admin-api/guides/apple-pay.md), [PayPal](/docs/admin-api/guides/paypal.md), [Klarna](/docs/admin-api/guides/klarna.md), [Twint](/docs/admin-api/guides/twint.md), [Bancontact](/docs/admin-api/guides/bancontact.md), and [SEPA](/docs/admin-api/guides/sepa-debit.md).
107
107
:::
108
108
109
109
### Add Upsells
110
110
111
-
Add additional products (line items) to the original order through the [ordersAddLineItemsCreate](/docs/api/admin/reference/#/operations/ordersAddLineItemsCreate) API. Adding items to the order will automatically re-use the order's initial payment method to collect payment for the additional products.
111
+
Add additional products (line items) to the original order through the [ordersAddLineItemsCreate](/docs/admin-api/reference/#/operations/ordersAddLineItemsCreate) API. Adding items to the order will automatically re-use the order's initial payment method to collect payment for the additional products.
112
112
113
113
```json title="Request"
114
114
// POST https://{store}.29next.store/api/admin/orders/<NUMBER>/add-line-items/
@@ -220,7 +220,7 @@ Cart and Order `attribution` object sets the [marketing attribution](https://doc
220
220
The `shipping_code` is an optional field to specify the Shipping Method to be used for the order, **if not passed, the cheapest Shipping Method will be used**. `shipping_price` is also optional and provides a way to override the configured price for the Shipping Method of the order allowing you to discount or charge an upsell for shipping on the order.
221
221
222
222
### Order Addresses Detail
223
-
The `shipping_address` object on the order represents the address where the order will be shipped, and similarly for the `billing_address`. The first `shipping_address` and `billing_address` created for a user is automatically set as their default shipping and billing address, [see API Reference](/docs/api/admin/reference/#/operations/orders_create).
223
+
The `shipping_address` object on the order represents the address where the order will be shipped, and similarly for the `billing_address`. The first `shipping_address` and `billing_address` created for a user is automatically set as their default shipping and billing address, [see API Reference](/docs/admin-api/reference/#/operations/orders_create).
224
224
225
225
:::tip
226
226
Use `billing_same_as_shipping_address` to forego having to pass a full duplicate address for `billing_address`.
@@ -249,7 +249,7 @@ Use `billing_same_as_shipping_address` to forego having to pass a full duplicate
249
249
250
250
The order `payment_method` and `payment_details` objects work in tandem to specify the payment method for the order and provide any additional data that may be required per payment method.
251
251
252
-
The example below uses a [Test Card Token](/docs/api/admin/guides/testing-guide.md#test-card-tokens) to create a **Test Order**.
252
+
The example below uses a [Test Card Token](/docs/admin-api/guides/testing-guide.md#test-card-tokens) to create a **Test Order**.
253
253
254
254
255
255
```json
@@ -272,14 +272,14 @@ See payment method specific guides on creating orders below.
0 commit comments