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'

AssignedFulfillmentOrder

Requires assigned_fulfillment_orders access scope.

A list of all the fulfillment orders that are assigned to an app at the shop level. The list of fulfillment orders can be filtered by location and assignment status.

Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) may host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated fulfillment requests or might currently not be requested to be fulfilled.

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

The AssignedFulfillmentOrder resource

Properties
assigned_location_id
read-only
->legacyResourceId
The ID of the fulfillment order's assigned location. This is the location from which the order is expected to be fulfilled.
destination
read-only
->destination

The destination where the items should be sent upon fulfillment.

id
read-only
->id
The ID of the fulfillment order.
line_items
read-only
->lineItems

Represents line items belonging to a fulfillment order:

order_id
read-only
->legacyResourceId
The ID of the order that's associated with the fulfillment order.
request_status
read-only
->requestStatus

The request status of the fulfillment order. Valid values:

shop_id
deprecated
The ID of the shop that's associated with the fulfillment order.
status
read-only
->status

The status of the fulfillment order. Valid values:

Was this section helpful?
{}The AssignedFulfillmentOrder resource
{
  "assigned_location_id": 3183479,
  "destination": {
    "id": 54433189,
    "address1": "123 Amoebobacterieae St",
    "address2": "Unit 806",
    "city": "Ottawa",
    "company": "",
    "country": "Canada",
    "email": "bob@example.com",
    "first_name": "Bob",
    "last_name": "Bobsen",
    "phone": "(555)555-5555",
    "province": "Ontario",
    "zip": "K2P0V6"
  },
  "id": 255858046,
  "line_items": [
    {
      "id": 466157049,
      "shop_id": 3998762,
      "fulfillment_order_id": 1568020,
      "line_item_id": 466157049,
      "inventory_item_id": 6588097,
      "quantity": 1,
      "fulfillable_quantity": 1
    }
  ],
  "order_id": 3183479,
  "request_status": "unsubmitted",
  "shop_id": 255858046,
  "status": "open"
}
Anchor to section titled 'GET request, Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app'

get
Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app

shop

Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app.

The app must have the read_assigned_fulfillment_orders access scope to be able to retrieve fulfillment orders assigned to its locations.

All assigned fulfillment orders (except those with the CLOSED status) will be returned by default. Perform filtering with the assignment_status query parameter to receive only fulfillment orders that have been requested to be fulfilled.

Anchor to section titled 'Parameters of Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app'

Parameters

api_version
string
required
assignment_status
The assignment status of the fulfillment orders that should be returned. If assignment_status parameter isn't provided, then the query will return all assigned fulfillment orders, except those with the CLOSED status.
location_ids
The IDs of the assigned locations of the fulfillment orders that should be returned.
If the location_ids parameter isn't provided, then all fulfillment orders assigned to the shop locations that are managed by the app will be returned.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app'

Examples

Query parameters
assignmentstatus=cancellation_requested
The assignment status of the fulfillment orders that should be returned. If assignment_status parameter isn't provided, then the query will return all assigned fulfillment orders, except those with the CLOSED status.
Was this section helpful?
get
/admin/api/2024-10/assigned_fulfillment_orders.json?assignmentstatus=cancellation_requested&locationids[]=24826418
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids%5B%5D=24826418" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "fulfillment_orders": [
    {
      "id": 1046000802,
      "created_at": "2024-09-19T10:20:06-04:00",
      "updated_at": "2024-09-19T10:20:06-04:00",
      "shop_id": 548380009,
      "order_id": 450789469,
      "assigned_location_id": 24826418,
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "fulfill_at": null,
      "supported_actions": [
        "create_fulfillment",
        "cancel_fulfillment_order"
      ],
      "destination": {
        "id": 1042572134,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "email": "bob.norman@mail.example.com",
        "first_name": "Bob",
        "last_name": "Norman",
        "phone": "+1(502)-459-2181",
        "province": "Kentucky",
        "zip": "40202"
      },
      "line_items": [
        {
          "id": 1058737511,
          "shop_id": 548380009,
          "fulfillment_order_id": 1046000802,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "international_duties": null,
      "fulfillment_holds": [],
      "fulfill_by": null,
      "delivery_method": null,
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 24826418,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}