Drop Ship Purchase Orders

Accept a DropShipPurchaseOrder (async)

The DropShipPurchaseOrder accept API is used by merchants to accept a drop ship purchase order and provide LiftForward with it's merchant_drop_ship_purchase_order_id.

Merchants should use this API after they are notified of a new drop ship purchase order via the notification webhook. Accepting a drop ship purchase order will trigger a confirmation email to the customer and notify LiftForward that a merchant has begun fulfillment of the order.

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.

When accepting a DropShipPurchaseOrder merchant are encouraged to provide a merchant_drop_ship_purchase_order_id. As this will make calling the fulfill, cancel and return APIs easier. Merchants who choose not to set a merchant_drop_ship_purchase_order_id will need to use the LiftForward drop_ship_purchase_order_id on subsequent API calls.

post/drop_ship_purchase_orders/accept

Request

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

Request body

Example request

{
  "drop_ship_purchase_order_accept": {
    "drop_ship_purchase_order_id": "4gzny7pdj87mkvbkhc3gq74pjwh",
    "merchant_drop_ship_purchase_order_id": "LFOR12345ABDF",
    "merchant_drop_ship_purchase_order_record_id": "12345A"
  }
}

Response

Accept 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.