AssignedFulfillmentOrder

Version 2020-01

The AssignedFulfillmentOrder resource allows you to retrieve 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 such as cancellation_requested and fulfillment_requested.

What you can do with AssignedFulfillmentOrder

The Shopify API lets you do the following with the AssignedFulfillmentOrder resource. More detailed versions of these general actions may be available:

AssignedFulfillmentOrder properties

assigned_location_id
"assigned_location_id": 3183479

The ID of the location that has been assigned to do the work.

destination
"destination": {
  "id": 54433189,
  "address1": "123 Amoebobacterieae St",
  "address2": "Unit 806",
  "city": "Ottawa",
  "company": "",
  "country": "Canada",
  "email": "bob@customer.com",
  "first_name": "Bob",
  "last_name": "Bobsen",
  "phone": "(555)555-5555",
  "province": "Ontario",
  "zip": "K2P0V6"
}

The destination where the items should be sent.

  • id: The ID of the fulfillment order destination.
  • address1: The first line of the address of the destination.
  • address2: The second line of the address of the destination.
  • city: The city of the destination.
  • company: The company of the destination.
  • country: The country of the destination.
  • email: The email of the customer at the destination.
  • first_name: The first name of the customer at the destination.
  • last_name: The last name of the customer at the destination.
  • phone: The phone number of the customer at the destination.
  • province: The province of the destination.
  • zip: The ZIP code of the destination.

id
"id": 255858046

The ID of the fulfillment order.

line_items
"line_items": [
  {
    "id": 466157049,
    "shop_id": 3998762,
    "fulfillment_order_id": 1568020,
    "line_item_id": 466157049,
    "inventory_item_id": 6588097,
    "quantity": 1,
    "fulfillable_quantity": 1
  }
]

Represents line items belonging to a fulfillment order:

  • id: The ID of the fulfillment order line item.
  • shop_id: The ID of the shop associated with the fulfillment order line item.
  • fulfillment_order_id: The ID of the fulfillment order associated with this line item.
  • line_item_id: The ID of the line item associated with this fulfillment order line item.
  • inventory_item_id: The ID of the inventory item associated with this fulfillment order line item.
  • quantity: The total number of units to be fulfilled.
  • fulfillable_quantity: The number of units remaining to be fulfilled.

order_id
"order_id": 3183479

The ID of the order that's associated with the fulfillment order.

request_status
"request_status": "unsubmitted"

The request status of the fulfillment order. Valid values:

  • unsubmitted: The initial state for newly created fulfillment orders. This is the only valid state for fulfillment orders not assigned to a fulfillment service.
  • submitted: The merchant requested fulfillment for this fulfillment order.
  • accepted: The fulfillment service accepted the merchant's fulfillment request.
  • rejected: The fulfillment service rejected the merchant's fulfillment request.
  • cancellation_requested: The merchant requested a cancellation of the fulfillment request for this fulfillment order.
  • cancellation_accepted: The fulfillment service accepted the merchant's fulfillment cancellation request.
  • cancellation_rejected: The fulfillment service rejected the merchant's fulfillment cancellation request.
  • closed: The fulfillment service closed the fulfillment order without completing it.

shop_id
"shop_id": 255858046

The ID of the shop that's associated with the fulfillment order.

status
"status": "open"

The status of the fulfillment order. Valid values:

  • open: Default state for newly created fulfillment orders.
  • in_progress: The fulfillment order is being processed.
  • cancelled: The fulfillment order has been cancelled by the merchant.
  • incomplete: The fulfillment order cannot be completed as requested.
  • closed: The fulfillment order has been completed and closed.

Endpoints

GET /admin/api/2020-01/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
Retrieves a list of fulfillment orders on a shop for a specific app.
assignment_status

The assigment status of the fulfillment orders that should be returned:

  • cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.
  • fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
  • fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
location_ids

The IDs of the assigned locations of the fulfillment orders that should be returned.

Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app

GET /admin/api/2020-07/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
View Response
HTTP/1.1 200 OK
{
  "fulfillment_orders": [
    {
      "id": 1046000790,
      "shop_id": 690933842,
      "order_id": 450789469,
      "assigned_location_id": 48752903,
      "fulfillment_service_handle": "shipwire-app",
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "supported_actions": [
        "cancel_fulfillment_order",
        "create_fulfillment"
      ],
      "destination": {
        "id": 1025578628,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "last_name": "Norman",
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202"
      },
      "line_items": [
        {
          "id": 1025578640,
          "shop_id": 690933842,
          "fulfillment_order_id": 1046000790,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 48752903,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}
Version 2020-04

The AssignedFulfillmentOrder resource allows you to retrieve 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 such as cancellation_requested and fulfillment_requested.

What you can do with AssignedFulfillmentOrder

The Shopify API lets you do the following with the AssignedFulfillmentOrder resource. More detailed versions of these general actions may be available:

AssignedFulfillmentOrder properties

assigned_location_id
"assigned_location_id": 3183479

The ID of the location that has been assigned to do the work.

destination
"destination": {
  "id": 54433189,
  "address1": "123 Amoebobacterieae St",
  "address2": "Unit 806",
  "city": "Ottawa",
  "company": "",
  "country": "Canada",
  "email": "bob@customer.com",
  "first_name": "Bob",
  "last_name": "Bobsen",
  "phone": "(555)555-5555",
  "province": "Ontario",
  "zip": "K2P0V6"
}

The destination where the items should be sent.

  • id: The ID of the fulfillment order destination.
  • address1: The first line of the address of the destination.
  • address2: The second line of the address of the destination.
  • city: The city of the destination.
  • company: The company of the destination.
  • country: The country of the destination.
  • email: The email of the customer at the destination.
  • first_name: The first name of the customer at the destination.
  • last_name: The last name of the customer at the destination.
  • phone: The phone number of the customer at the destination.
  • province: The province of the destination.
  • zip: The ZIP code of the destination.

id
"id": 255858046

The ID of the fulfillment order.

line_items
"line_items": [
  {
    "id": 466157049,
    "shop_id": 3998762,
    "fulfillment_order_id": 1568020,
    "line_item_id": 466157049,
    "inventory_item_id": 6588097,
    "quantity": 1,
    "fulfillable_quantity": 1
  }
]

Represents line items belonging to a fulfillment order:

  • id: The ID of the fulfillment order line item.
  • shop_id: The ID of the shop associated with the fulfillment order line item.
  • fulfillment_order_id: The ID of the fulfillment order associated with this line item.
  • line_item_id: The ID of the line item associated with this fulfillment order line item.
  • inventory_item_id: The ID of the inventory item associated with this fulfillment order line item.
  • quantity: The total number of units to be fulfilled.
  • fulfillable_quantity: The number of units remaining to be fulfilled.

order_id
"order_id": 3183479

The ID of the order that's associated with the fulfillment order.

request_status
"request_status": "unsubmitted"

The request status of the fulfillment order. Valid values:

  • unsubmitted: The initial state for newly created fulfillment orders. This is the only valid state for fulfillment orders not assigned to a fulfillment service.
  • submitted: The merchant requested fulfillment for this fulfillment order.
  • accepted: The fulfillment service accepted the merchant's fulfillment request.
  • rejected: The fulfillment service rejected the merchant's fulfillment request.
  • cancellation_requested: The merchant requested a cancellation of the fulfillment request for this fulfillment order.
  • cancellation_accepted: The fulfillment service accepted the merchant's fulfillment cancellation request.
  • cancellation_rejected: The fulfillment service rejected the merchant's fulfillment cancellation request.
  • closed: The fulfillment service closed the fulfillment order without completing it.

shop_id
"shop_id": 255858046

The ID of the shop that's associated with the fulfillment order.

status
"status": "open"

The status of the fulfillment order. Valid values:

  • open: Default state for newly created fulfillment orders.
  • in_progress: The fulfillment order is being processed.
  • cancelled: The fulfillment order has been cancelled by the merchant.
  • incomplete: The fulfillment order cannot be completed as requested.
  • closed: The fulfillment order has been completed and closed.

Endpoints

GET /admin/api/2020-04/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
Retrieves a list of fulfillment orders on a shop for a specific app.
assignment_status

The assigment status of the fulfillment orders that should be returned:

  • cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.
  • fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
  • fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
location_ids

The IDs of the assigned locations of the fulfillment orders that should be returned.

Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app

GET /admin/api/2020-07/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
View Response
HTTP/1.1 200 OK
{
  "fulfillment_orders": [
    {
      "id": 1046000790,
      "shop_id": 690933842,
      "order_id": 450789469,
      "assigned_location_id": 48752903,
      "fulfillment_service_handle": "shipwire-app",
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "supported_actions": [
        "cancel_fulfillment_order",
        "create_fulfillment"
      ],
      "destination": {
        "id": 1025578628,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "last_name": "Norman",
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202"
      },
      "line_items": [
        {
          "id": 1025578640,
          "shop_id": 690933842,
          "fulfillment_order_id": 1046000790,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 48752903,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}
Version 2020-07 (Latest)

The AssignedFulfillmentOrder resource allows you to retrieve 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 such as cancellation_requested and fulfillment_requested.

What you can do with AssignedFulfillmentOrder

The Shopify API lets you do the following with the AssignedFulfillmentOrder resource. More detailed versions of these general actions may be available:

AssignedFulfillmentOrder properties

assigned_location_id
"assigned_location_id": 3183479

The ID of the location that has been assigned to do the work.

destination
"destination": {
  "id": 54433189,
  "address1": "123 Amoebobacterieae St",
  "address2": "Unit 806",
  "city": "Ottawa",
  "company": "",
  "country": "Canada",
  "email": "bob@customer.com",
  "first_name": "Bob",
  "last_name": "Bobsen",
  "phone": "(555)555-5555",
  "province": "Ontario",
  "zip": "K2P0V6"
}

The destination where the items should be sent.

  • id: The ID of the fulfillment order destination.
  • address1: The first line of the address of the destination.
  • address2: The second line of the address of the destination.
  • city: The city of the destination.
  • company: The company of the destination.
  • country: The country of the destination.
  • email: The email of the customer at the destination.
  • first_name: The first name of the customer at the destination.
  • last_name: The last name of the customer at the destination.
  • phone: The phone number of the customer at the destination.
  • province: The province of the destination.
  • zip: The ZIP code of the destination.

id
"id": 255858046

The ID of the fulfillment order.

line_items
"line_items": [
  {
    "id": 466157049,
    "shop_id": 3998762,
    "fulfillment_order_id": 1568020,
    "line_item_id": 466157049,
    "inventory_item_id": 6588097,
    "quantity": 1,
    "fulfillable_quantity": 1
  }
]

Represents line items belonging to a fulfillment order:

  • id: The ID of the fulfillment order line item.
  • shop_id: The ID of the shop associated with the fulfillment order line item.
  • fulfillment_order_id: The ID of the fulfillment order associated with this line item.
  • line_item_id: The ID of the line item associated with this fulfillment order line item.
  • inventory_item_id: The ID of the inventory item associated with this fulfillment order line item.
  • quantity: The total number of units to be fulfilled.
  • fulfillable_quantity: The number of units remaining to be fulfilled.

order_id
"order_id": 3183479

The ID of the order that's associated with the fulfillment order.

request_status
"request_status": "unsubmitted"

The request status of the fulfillment order. Valid values:

  • unsubmitted: The initial state for newly created fulfillment orders. This is the only valid state for fulfillment orders not assigned to a fulfillment service.
  • submitted: The merchant requested fulfillment for this fulfillment order.
  • accepted: The fulfillment service accepted the merchant's fulfillment request.
  • rejected: The fulfillment service rejected the merchant's fulfillment request.
  • cancellation_requested: The merchant requested a cancellation of the fulfillment request for this fulfillment order.
  • cancellation_accepted: The fulfillment service accepted the merchant's fulfillment cancellation request.
  • cancellation_rejected: The fulfillment service rejected the merchant's fulfillment cancellation request.
  • closed: The fulfillment service closed the fulfillment order without completing it.

shop_id
"shop_id": 255858046

The ID of the shop that's associated with the fulfillment order.

status
"status": "open"

The status of the fulfillment order. Valid values:

  • open: Default state for newly created fulfillment orders.
  • in_progress: The fulfillment order is being processed.
  • cancelled: The fulfillment order has been cancelled by the merchant.
  • incomplete: The fulfillment order cannot be completed as requested.
  • closed: The fulfillment order has been completed and closed.

Endpoints

GET /admin/api/2020-07/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
Retrieves a list of fulfillment orders on a shop for a specific app.
assignment_status

The assigment status of the fulfillment orders that should be returned:

  • cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.
  • fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
  • fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
location_ids

The IDs of the assigned locations of the fulfillment orders that should be returned.

Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app

GET /admin/api/2020-07/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
View Response
HTTP/1.1 200 OK
{
  "fulfillment_orders": [
    {
      "id": 1046000790,
      "shop_id": 690933842,
      "order_id": 450789469,
      "assigned_location_id": 48752903,
      "fulfillment_service_handle": "shipwire-app",
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "supported_actions": [
        "cancel_fulfillment_order",
        "create_fulfillment"
      ],
      "destination": {
        "id": 1025578628,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "last_name": "Norman",
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202"
      },
      "line_items": [
        {
          "id": 1025578640,
          "shop_id": 690933842,
          "fulfillment_order_id": 1046000790,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 48752903,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}
Version 2020-10 (Release candidate)

The AssignedFulfillmentOrder resource allows you to retrieve 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 such as cancellation_requested and fulfillment_requested.

What you can do with AssignedFulfillmentOrder

The Shopify API lets you do the following with the AssignedFulfillmentOrder resource. More detailed versions of these general actions may be available:

AssignedFulfillmentOrder properties

assigned_location_id
"assigned_location_id": 3183479

The ID of the location that has been assigned to do the work.

destination
"destination": {
  "id": 54433189,
  "address1": "123 Amoebobacterieae St",
  "address2": "Unit 806",
  "city": "Ottawa",
  "company": "",
  "country": "Canada",
  "email": "bob@customer.com",
  "first_name": "Bob",
  "last_name": "Bobsen",
  "phone": "(555)555-5555",
  "province": "Ontario",
  "zip": "K2P0V6"
}

The destination where the items should be sent.

  • id: The ID of the fulfillment order destination.
  • address1: The first line of the address of the destination.
  • address2: The second line of the address of the destination.
  • city: The city of the destination.
  • company: The company of the destination.
  • country: The country of the destination.
  • email: The email of the customer at the destination.
  • first_name: The first name of the customer at the destination.
  • last_name: The last name of the customer at the destination.
  • phone: The phone number of the customer at the destination.
  • province: The province of the destination.
  • zip: The ZIP code of the destination.

id
"id": 255858046

The ID of the fulfillment order.

line_items
"line_items": [
  {
    "id": 466157049,
    "shop_id": 3998762,
    "fulfillment_order_id": 1568020,
    "line_item_id": 466157049,
    "inventory_item_id": 6588097,
    "quantity": 1,
    "fulfillable_quantity": 1
  }
]

Represents line items belonging to a fulfillment order:

  • id: The ID of the fulfillment order line item.
  • shop_id: The ID of the shop associated with the fulfillment order line item.
  • fulfillment_order_id: The ID of the fulfillment order associated with this line item.
  • line_item_id: The ID of the line item associated with this fulfillment order line item.
  • inventory_item_id: The ID of the inventory item associated with this fulfillment order line item.
  • quantity: The total number of units to be fulfilled.
  • fulfillable_quantity: The number of units remaining to be fulfilled.

order_id
"order_id": 3183479

The ID of the order that's associated with the fulfillment order.

request_status
"request_status": "unsubmitted"

The request status of the fulfillment order. Valid values:

  • unsubmitted: The initial state for newly created fulfillment orders. This is the only valid state for fulfillment orders not assigned to a fulfillment service.
  • submitted: The merchant requested fulfillment for this fulfillment order.
  • accepted: The fulfillment service accepted the merchant's fulfillment request.
  • rejected: The fulfillment service rejected the merchant's fulfillment request.
  • cancellation_requested: The merchant requested a cancellation of the fulfillment request for this fulfillment order.
  • cancellation_accepted: The fulfillment service accepted the merchant's fulfillment cancellation request.
  • cancellation_rejected: The fulfillment service rejected the merchant's fulfillment cancellation request.
  • closed: The fulfillment service closed the fulfillment order without completing it.

shop_id
"shop_id": 255858046

The ID of the shop that's associated with the fulfillment order.

status
"status": "open"

The status of the fulfillment order. Valid values:

  • open: Default state for newly created fulfillment orders.
  • in_progress: The fulfillment order is being processed.
  • cancelled: The fulfillment order has been cancelled by the merchant.
  • incomplete: The fulfillment order cannot be completed as requested.
  • closed: The fulfillment order has been completed and closed.

Endpoints

GET /admin/api/2020-10/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
Retrieves a list of fulfillment orders on a shop for a specific app.
assignment_status

The assigment status of the fulfillment orders that should be returned:

  • cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.
  • fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
  • fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
location_ids

The IDs of the assigned locations of the fulfillment orders that should be returned.

Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app

GET /admin/api/2020-07/assigned_fulfillment_orders.json?assignment_status=cancellation_requested&location_ids[]=48752903
View Response
HTTP/1.1 200 OK
{
  "fulfillment_orders": [
    {
      "id": 1046000790,
      "shop_id": 690933842,
      "order_id": 450789469,
      "assigned_location_id": 48752903,
      "fulfillment_service_handle": "shipwire-app",
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "supported_actions": [
        "cancel_fulfillment_order",
        "create_fulfillment"
      ],
      "destination": {
        "id": 1025578628,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "last_name": "Norman",
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202"
      },
      "line_items": [
        {
          "id": 1025578640,
          "shop_id": 690933842,
          "fulfillment_order_id": 1046000790,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 48752903,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}