LIliftforward
Drop Ship Purchase Orders

Index DropShipPurchaseOrders

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.
get/drop_ship_purchase_orders

Request

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

Query parameters

merchant_drop_ship_purchase_order_idstring

Filters the results by merchant_drop_ship_purchase_order_id.

drop_ship_purchase_order_idstring

Filters the results by drop_ship_purchase_order_id.

pageinteger

Indicates which page of results to return.

per_pageinteger

Indicates the number of results to include in each page.

Response

Index DropShipPurchaseOrders

Example response

{
  "drop_ship_purchase_orders": [
    {
      "drop_ship_purchase_order_id": "4gzny7pdj87mkvbkhc3gq74pjwh",
      "merchant_drop_ship_purchase_order_id": "LFOR12345ABDF",
      "merchant_drop_ship_purchase_order_record_id": "12345A",
      "merchant_customer_id": "dpfcc3ppaxf8k9w8zcs5h9fddhw",
      "program_code": "program-abc",
      "source_channel_id": "ONLINE_SHIP_TO_HOME",
      "created_at": "2022-10-08T20:30:59Z",
      "status": "ACTIVE",
      "phone_number": "+18403240590",
      "email": "elliot.alderson@gmail.com",
      "merchant_marketing_opt_in": true,
      "sales_associate_email": "darlene.alderson@gmail.com",
      "location_id": "e764p7nbhd9kvhtcd9v5perttys",
      "merchant_location_id": "Store 1234",
      "lender_order_id": "d5bfca82-dc0d-4de1-acbc-1f34df7adfb7",
      "currency": "USD",
      "order_shipping_fees": 9.99,
      "total_price": 1200,
      "returnable": true,
      "billing_address": {
        "address_line_1": "217 East Broadway",
        "address_line_2": "Apt. 4E",
        "city": "New York",
        "state_code": "NY",
        "postal_code": "10002",
        "country_code": "US",
        "first_name": "Elliot",
        "last_name": "Alderson"
      },
      "shipping_address": {
        "address_line_1": "217 East Broadway",
        "address_line_2": "Apt. 4E",
        "city": "New York",
        "state_code": "NY",
        "postal_code": "10002",
        "country_code": "US",
        "first_name": "Elliot",
        "last_name": "Alderson"
      },
      "items": [
        {
          "drop_ship_purchase_order_item_id": "pqa6pkfn7x5xsjtj24f9bd45r75",
          "sku": "MP12345",
          "product_id": "j6c9s442wca73nhtnv3f8n99t7d",
          "product_name": "Pineapple Phone 14 Pro 256GB",
          "quantity": 1,
          "serial_number": "SN1234",
          "carrier": "UPS",
          "tracking_number": "920482948394",
          "status": "active",
          "returnable": true,
          "created_at": "2022-10-08T20:30:59Z",
          "fulfilled_at": "2022-10-08T20:30:59Z",
          "unit_sale_price": 299.99,
          "unit_shipping_fee": 5.49,
          "unit_sales_tax": 3.69,
          "unit_environmental_fees": 4.79,
          "unit_misc_fees": 2.59,
          "unit_total_price": 316.55,
          "merchant_order_item_id": "ITEM-123",
          "parent_merchant_order_item_id": "DEVICE-123",
          "parent_drop_ship_purchase_order_item_id": "gbzct76apzjfczcbhhes9z6t5ev",
          "lender_order_item_id": "725f65de-6307-4d4f-a6be-ca4991299c86",
          "subscription_plan": {
            "subscription_plan_id": "standard-plan-30",
            "program_code": "subscription-us",
            "plan_code": "standard",
            "plan_name": "Standard Plan",
            "plan_subtitle": "This is the basic plan.",
            "plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
            "financing_plan_type": "financing"
          }
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_pages": 10,
    "total_records": 250
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.