Skip to main content
POST
/
fulfillmentPlans
/
{sellerId}
/
preview
Plan fulfillment
curl --request POST \
  --url https://api.quivo.co/fulfillmentPlans/{sellerId}/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": 123,
  "excludeWhenIds": [
    123
  ],
  "when": {
    "type": "RULE",
    "order": 123,
    "sku": "<string>",
    "deliveryCountry": "<string>",
    "scriptedCondition": "<string>",
    "thens": [
      {
        "order": 123,
        "sku": "<string>",
        "quantity": "<string>",
        "warehouse": "<string>",
        "customsValue": "<string>",
        "splitId": "<string>",
        "lot": "<string>",
        "expirationDate": "<string>"
      }
    ]
  }
}
'
[
  {
    "warehouse": "<string>",
    "positions": [
      {
        "sku": "<string>",
        "warehouseSku": "<string>",
        "quantity": 123,
        "lot": "<string>",
        "customsValue": 123,
        "expirationDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Path Parameters

​
sellerId
integer<int64>
required

The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources.

Body

application/json

Request body data for Plan fulfillment

Request payload for previewing the effects of a fulfillment plan change. Contains proposed plan modifications to simulate fulfillment outcomes without applying changes.

​
orderId
integer<int64>

The unique identifier for the order

​
excludeWhenIds
integer<int64>[]

The unique identifier for the excludewhens

​
when
object

Request payload for creating a new fulfillment plan for a seller. Contains plan configuration including SKU mappings, warehouse assignments, and effective dates.

Response

Returns a preview of the fulfillment plan changes without applying them.

​
warehouse
string

Warehouse identifier or information

​
positions
object[]

Array of position items