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": {
    "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>"
      }
    ]
  }
}
'
import requests

url = "https://api.quivo.co/fulfillmentPlans/{sellerId}/preview"

payload = {
"orderId": 123,
"excludeWhenIds": [123],
"when": {
"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>"
}
]
}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
orderId: 123,
excludeWhenIds: [123],
when: {
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>'
}
]
}
})
};

fetch('https://api.quivo.co/fulfillmentPlans/{sellerId}/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quivo.co/fulfillmentPlans/{sellerId}/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => 123,
'excludeWhenIds' => [
123
],
'when' => [
'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>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.quivo.co/fulfillmentPlans/{sellerId}/preview"

payload := strings.NewReader("{\n \"orderId\": 123,\n \"excludeWhenIds\": [\n 123\n ],\n \"when\": {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"deliveryCountry\": \"<string>\",\n \"scriptedCondition\": \"<string>\",\n \"thens\": [\n {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"quantity\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"customsValue\": \"<string>\",\n \"splitId\": \"<string>\",\n \"lot\": \"<string>\",\n \"expirationDate\": \"<string>\"\n }\n ]\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.quivo.co/fulfillmentPlans/{sellerId}/preview")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": 123,\n \"excludeWhenIds\": [\n 123\n ],\n \"when\": {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"deliveryCountry\": \"<string>\",\n \"scriptedCondition\": \"<string>\",\n \"thens\": [\n {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"quantity\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"customsValue\": \"<string>\",\n \"splitId\": \"<string>\",\n \"lot\": \"<string>\",\n \"expirationDate\": \"<string>\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.quivo.co/fulfillmentPlans/{sellerId}/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": 123,\n \"excludeWhenIds\": [\n 123\n ],\n \"when\": {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"deliveryCountry\": \"<string>\",\n \"scriptedCondition\": \"<string>\",\n \"thens\": [\n {\n \"order\": 123,\n \"sku\": \"<string>\",\n \"quantity\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"customsValue\": \"<string>\",\n \"splitId\": \"<string>\",\n \"lot\": \"<string>\",\n \"expirationDate\": \"<string>\"\n }\n ]\n }\n}"

response = http.request(request)
puts response.read_body
[
  {
    "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