Drop Ship Purchase Orders

Fulfill a DropShipPurchaseOrder (async)

When the merchant fulfills a drop ship purchase order via shipping or in-store, the merchant is responsible for notifying LiftForward of the fulfillment along with the required data. Fulfillment marks the corresponding customer's subscription order items as active, captures payment on the existing credit authorization, and finalized the customer's line of credit. Drop ship purchase orders remain open until they are fulfilled or canceled. Fulfillment applies only to an existing drop ship purchase order that LiftForward has created for the merchant.

One of the following 2 unique identifiers for the drop ship purchase order must be provided:

  • 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, as sent in the drop ship purchase order notification webhook.

When both are provided, the drop ship purchase order is looked up by drop_ship_purchase_order_id only. A 404 response means none of the merchant's drop ship purchase orders matched the identifier at the time of the request.

If the items parameter is not provided, all items in the drop ship purchase order will be fulfilled. Some programs require serial numbers to be provided for fulfillment of some items. In these cases merchants should provide the serial_number with the sku for each item requiring a serial number. If the item does not require a serial number, the serial_number parameter should be omitted of passed as null.

Some programs only support full fulfillment of an order. If the items parameter specifies fewer items than remain to be fulfilled, a 422 error will be returned for those programs.

post/drop_ship_purchase_orders/fulfill

Request

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

Request body

Example request

{
  "drop_ship_purchase_order_fulfill": {
    "drop_ship_purchase_order_id": "4gzny7pdj87mkvbkhc3gq74pjwh",
    "merchant_drop_ship_purchase_order_id": "LFOR12345ABDF",
    "merchant_drop_ship_purchase_order_record_id": "12345A",
    "fulfilled_at": "2022-10-08T10:22:55.340Z",
    "items": [
      {
        "sku": "MP-12345",
        "quantity": 1,
        "serial_number": "SN1234",
        "carrier": "UPS",
        "tracking_number": "920482948394"
      }
    ]
  }
}

Response

Fulfill a DropShipPurchaseOrder (async)

request_idstring required

LiftForward's unique ID for a single API request

codestring required

HTTP response status code

statusstring required

A value of 'success' is returned when status code in the 200 range. This action has been successfully completed or queued for processing and should be considered successful.

messagestring

Additional information about the status of the API request.

request_urlstring

The API endpoint that was called.

request_parametersobject

Parameters submitted by the API call for confirmation.

Example response

{
  "request_id": "fb20f856-0f09-4927-b1b2-5393c68c589b",
  "code": "200",
  "status": "successful",
  "message": "The request has been queued and is considered successful.",
  "request_url": "/orders/123456"
}

Changes

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