The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

LocationsForMove

Requires merchant_managed_fulfillment_orders access scope.

The LocationsForMove resource represents the locations that a fulfillment order can potentially move to.

Was this section helpful?
#Endpoints
Anchor to section titled 'The LocationsForMove resource'

The LocationsForMove resource

Properties
locations_for_move
read-only
->locationsForMove

A list of locations that a fulfillment order can potentially move to.

Was this section helpful?
{}The LocationsForMove resource
{
  "locations_for_move": [
    {
      "location": {
        "id": 5,
        "name": "123 Main St"
      },
      "movable": false,
      "message": "Shirt - Medium can't be changed because it isn't stocked at this location."
    },
    {
      "location": {
        "id": 3,
        "name": "Alpha Location"
      },
      "movable": true,
      "message": null
    },
    {
      "location": {
        "id": 1,
        "name": "Bravo Location"
      },
      "movable": false,
      "message": "Current location."
    },
    {
      "location": {
        "id": 2,
        "name": "Charlie Location"
      },
      "movable": false,
      "message": "No items are stocked at this location."
    },
    {
      "location": {
        "id": 4,
        "name": "Delta Location"
      },
      "movable": false,
      "message": "2 items can't be changed because they aren't stocked at this location."
    }
  ]
}
Anchor to section titled 'GET request, Retrieves a list of locations that a fulfillment order can potentially move to.'

get
Retrieves a list of locations that a fulfillment order can potentially move to.

fulfillmentOrder
Retrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
Anchor to section titled 'Parameters of Retrieves a list of locations that a fulfillment order can potentially move to.'

Parameters

api_version
string
required
fulfillment_order_id
string
required
fulfillment_order_id
The ID of the fulfillment order.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of locations that a fulfillment order can potentially move to.'

Examples

Was this section helpful?
get
/admin/api/2024-10/fulfillment_orders/1046000801/locations_for_move.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/fulfillment_orders/1046000801/locations_for_move.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "locations_for_move": [
    {
      "location": {
        "id": 1072404542,
        "name": "Alpha Location"
      },
      "message": "Current location.",
      "movable": false
    },
    {
      "location": {
        "id": 1072404543,
        "name": "Bravo Location"
      },
      "message": "No items are stocked at this location.",
      "movable": false
    }
  ]
}