Drop Ship Purchase Orders

Cancel a DropShipPurchaseOrder (async)

Drop ship purchase orders can be canceled when fulfillment has not yet been processed. Canceling will cancel the corresponding customer's subscription order items and all related payment authorizations. Drop ship purchase orders remain open until they are fulfilled or canceled.

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 omitted, all items in the drop ship purchase order will be canceled.

Some programs only support full cancellation of an order. If the items parameter is provided and does not include all items in the order, a 422 error will be returned for those programs.

post/drop_ship_purchase_orders/cancel

Request

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

Request body

Example request

{
  "drop_ship_purchase_order_cancel": {
    "drop_ship_purchase_order_id": "4gzny7pdj87mkvbkhc3gq74pjwh",
    "merchant_drop_ship_purchase_order_id": "LFOR12345ABDF",
    "merchant_drop_ship_purchase_order_record_id": "12345A",
    "canceled_at": "2022-10-08T10:22:55.340Z",
    "items": [
      {
        "sku": "MP-12345",
        "serial_number": "SN1234"
      }
    ]
  }
}

Response

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