---
title: "Index DropShipPurchaseOrders"
method: GET
path: "/drop_ship_purchase_orders"
tags: ["Drop Ship Purchase Orders"]
---

# Index DropShipPurchaseOrders

`GET /drop_ship_purchase_orders`

## Request

- Base URL: `https://api.liftforward.com`
- URL: `https://api.liftforward.com/drop_ship_purchase_orders`
- Auth: API key in header `Api-Key`

Returns a paginated list of DropShipPurchaseOrders.

When a customer places a Order through LiftForward's ecommerce experiences,
one or more DropShipPurchaseOrders are created by LiftForward to represent orders that needs to
be fulfilled by the merchant or other third party. The term 'drop ship' is used to reference that the
purchase orders are to be delivered directly to the end-customer and not an intermediate facility.
Typically each DropShipPurchaseOrder is matched by 1 order in the merchant's fulfillment system.

Depending on the style of integration merchants will make use of the fulfill, return, cancel and sometimes
update and accept DropShipPurchaseOrder APIs to manage the lifecycle of the DropShipPurchaseOrder.

Merchant can filter the results using the following parameters:
  - `merchant_drop_ship_purchase_order_id` - The merchant's unique identifier for the drop ship purchase order.
  - `drop_ship_purchase_order_id` - The LiftForward unique identifier for the drop ship purchase order.

## Query parameters

- `merchant_drop_ship_purchase_order_id` string
- `drop_ship_purchase_order_id` string
- `page` integer
- `per_page` integer

## Response `200`

Index DropShipPurchaseOrders

- MerchantApiEntitiesDropShipPurchaseOrderIndexResponse: MerchantApi_Entities_DropShipPurchaseOrderIndexResponse model
  - `drop_ship_purchase_orders` DropShipPurchaseOrder[]
    - `drop_ship_purchase_order_id` string: LiftForward's drop ship purchase order Id
    - `merchant_drop_ship_purchase_order_id` string: Merchant's drop ship purchase order Id which is customer displayable
    - `merchant_drop_ship_purchase_order_record_id` string: Merchant's record Id which can be different than the customer displayable `merchant_drop_ship_purchase_order_id`
    - `merchant_customer_id` string, required: Unique identifier for customer, provided by the Merchant on create merchant customer api
    - `program_code` string, required: String provided by LiftForward to identify the Device as a Service Program.
    - `source_channel_id` 'IN_STORE' | 'ONLINE_IN_STORE' | 'ONLINE_SHIP_TO_HOME': String identifying the sales channel the order originated from. ONLINE_SHIP_TO_HOME for typical ecommerce, ONLINE_IN_STORE for click and collect, IN_STORE for point of sale.
    - `created_at` string, date-time, required: iso8601 Date and Time (UTC) the purchase order was created
    - `status` 'NEW' | 'PENDING' | 'PLACEMENT_PENDING' | 'PLACED' | 'CANCEL_REQUESTED' | 'CANCELLATION_PENDING' | 'CANCELLED' | 'ACTIVATION_PENDING' | 'ACTIVE' | 'RETURN_PENDING' | 'RETURNED', required: Status of the drop ship purchase order
    - `phone_number` string: Phone number of the customer including the country code prefix
    - `email` string: Email address of the customer
    - `merchant_marketing_opt_in` boolean, required: Indicates if the customer has opted in to receive marketing communications from the merchant
    - `sales_associate_email` string: Email address of sales associate associated with the drop ship purchase order
    - `location_id` string: LiftForward's Id for the location associated with the drop ship purchase order
    - `merchant_location_id` string: Merchant's Id for the location associated with the drop ship purchase order
    - `lender_order_id` string: ID assigned by the program lender for this order.
    - `currency` string, required: ISO 4217 3 character currency code.
    - `order_shipping_fees` number, float: A flat shipping fee for the entire drop ship purchase order
    - `total_price` number, float, required: Total price (including taxes and fees) the customer will pay for the drop ship purchase order
    - `fulfillable` boolean, required: Indicates if any items in the drop ship purchase order can be fulfilled
    - `cancelable` boolean, required: Indicates if any items in the drop ship purchase order can be canceled
    - `returnable` boolean, required: Indicates if any items in the drop ship purchase order can be returned
    - `billing_address` MerchantApiEntitiesOrderAddress
      - `address_line_1` string, required: Street address
      - `address_line_2` string: Apt, Floor, Suite etc..
      - `city` string, required: Address city.
      - `state_code` string, required: 2 letter US state code abbreviation.
      - `postal_code` string, required: Address zip code. Format NNNNN, NNNNNNNNN or NNNNN-NNNN in the US.
      - `country_code` string, required: 2 letter ISO-3166-1 country code.
      - `first_name` string, required: First name of customer.
      - `last_name` string, required: Last name of customer.
    - `shipping_address` MerchantApiEntitiesOrderAddress, required
      - `address_line_1` string, required: Street address
      - `address_line_2` string: Apt, Floor, Suite etc..
      - `city` string, required: Address city.
      - `state_code` string, required: 2 letter US state code abbreviation.
      - `postal_code` string, required: Address zip code. Format NNNNN, NNNNNNNNN or NNNNN-NNNN in the US.
      - `country_code` string, required: 2 letter ISO-3166-1 country code.
      - `first_name` string, required: First name of customer.
      - `last_name` string, required: Last name of customer.
    - `items` DropShipPurchaseOrderItem[], required: All items in the order are required
      - `drop_ship_purchase_order_item_id` string, required: LiftForward id for the drop ship purchase order item
      - `sku` string, required: Merchant's SKU for the product associated with the drop ship purchase order item
      - `product_id` string, required: LiftForward id for the product associated with the drop ship purchase order item
      - `product_name` string, required: Display name for product. Provided by the merchant in the product catalog import
      - `quantity` integer: Currently always 1 but here for future use
      - `serial_number` string: Serial number for the item if provided by the merchant
      - `carrier` string: Shipping carrier for the tracking number if provided by merchant
      - `tracking_number` string: Shipping carrier's tracking number if provided by merchant
      - `status` 'new' | 'pending' | 'placement_pending' | 'placed' | 'cancel_requested' | 'cancellation_pending' | 'cancelled' | 'activation_pending' | 'active' | 'return_pending' | 'returned': Status of the item's fulfillment
      - `fulfillable` boolean, required: Indicates of this item can be fulfilled
      - `cancelable` boolean, required: Indicates of this item can be canceled
      - `returnable` boolean, required: Indicates of this item can be returned
      - `created_at` string, date-time, required
      - `fulfilled_at` string, date-time, required
      - `unit_sale_price` number, float: Unit price the item was sold for
      - `unit_shipping_fee` number, float: Shipping fee for the item
      - `unit_sales_tax` number, float: Sales tax charged on the item
      - `unit_environmental_fees` number, float: Environment fee charged on the item
      - `unit_misc_fees` number, float: Miscellaneous fees charged on the item
      - `unit_total_price` number, float: Total unit price for the item including any taxes and fees.
      - `merchant_order_item_id` string: Merchant-provided ID for this order item
      - `parent_merchant_order_item_id` string: Merchant order item ID of the item that this item is linked to (e.g., indicates which item a service item is linked to)
      - `parent_drop_ship_purchase_order_item_id` string: LiftForward ID of the drop ship purchase order item that this item is linked to (e.g., indicates which item a service item is linked to)
      - `lender_order_item_id` string: ID assigned by the program lender for this item.
      - `subscription_plan` MerchantApiEntitiesSubscriptionPlanEntity
        - `subscription_plan_id` string, required: The unique id for this plan.
        - `program_code` string, required: The program code for the subscription plan.
        - `plan_code` string, required: A short string that identifies the type of plan independent of the installment_count.
        - `plan_name` string, required: A displayable name for this plan.
        - `plan_subtitle` string, required: Promotional copy to display for this plan.
        - `plan_summary` string, required: Longer summary description on the plan and it's benefits
        - `financing_plan_type` 'financing' | 'upgrade', required: The type of financing plan for this product.
    - `merchant_metadata` object: Arbitrary JSON Hash passed from the merchant
  - `meta` MetaEntity
    - `page` integer: Current page of results.
    - `per_page` integer: Results per page.
    - `total_pages` integer: Total number of pages in complete result set.
    - `total_records` integer: Total number of records in the complete result set.

## Other responses

- `400`: Invalid parameters
- `401`: Unauthorized
- `405`: Not Allowed
- `408`: Request Time Out
- `500`: Internal Service Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti.md) - [All operations](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti/llms.txt) - [OpenAPI document](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti/revisions/5a1383ffd271?raw)