Retrieves a list of fulfillment orders on a shop for a specific app

GET

/admin/api/{api_version}/assigned_fulfillment_orders.json

Retrieves a list of fulfillment orders on a shop for a specific app.

请求参数

Path 参数

api_version

string

必需

Query 参数

assignment_status

string

可选

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

示例值:

cancellation_requested

location_ids

string

可选

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Retrieves a list of fulfillment orders on a shop for a specific app

application/json

Body

fulfillment_orders

array[object (AssignedFulfillmentOrder) {8}]

可选

assigned_location_id

string

可选

The ID of the fulfillment order's assigned location. This is the location from which the order is expected to be fulfilled.

destination

string

可选

The destination where the items should be sent upon fulfillment.

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.

string

可选

The ID of the fulfillment order.

line_items

string

可选

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.

示例值:

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

order_id

string

可选

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

request_status

string

可选

The request status of the fulfillment order. Valid values:

unsubmitted:
The initial request status for the newly-created fulfillment orders. This is the only valid
request status for fulfillment orders that aren't 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

string

可选

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

status

string

可选

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.

示例

{
  "fulfillment_orders": [
    {
      "id": 1046000830,
      "shop_id": 548380009,
      "order_id": 450789469,
      "assigned_location_id": 24826418,
      "request_status": "cancellation_requested",
      "status": "in_progress",
      "supported_actions": [
        "cancel_fulfillment_order",
        "create_fulfillment"
      ],
      "destination": {
        "id": 1046000821,
        "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": 1058737568,
          "shop_id": 548380009,
          "fulfillment_order_id": 1046000830,
          "quantity": 1,
          "line_item_id": 518995019,
          "inventory_item_id": 49148385,
          "fulfillable_quantity": 1,
          "variant_id": 49148385
        }
      ],
      "outgoing_requests": [],
      "fulfillment_service_handle": "shipwire-app",
      "assigned_location": {
        "address1": null,
        "address2": null,
        "city": null,
        "country_code": "DE",
        "location_id": 24826418,
        "name": "Apple Api Shipwire",
        "phone": null,
        "province": null,
        "zip": null
      }
    }
  ]
}

修改于 2023-01-29 12:00:34

Remove an existing CarrierService

Retrieves a list of fulfillment events for a specific fulfillment