Create an order preparation

curl --request POST \
  --url localhost:///8080/v1/orderPreparations \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": {
    "should_label_packages": true,
    "should_palletise": true,
    "should_certify_commercial_invoices": true,
    "target_pickup_date": 123
  },
  "locations": {
    "preparing_warehouse_id": "<string>",
    "delivery_location_id": "<string>"
  },
  "name": "<string>",
  "owner_in_charge_of_moving_goods_in_fca_export": true,
  "picking_references": [
    "<string>"
  ],
  "commercial_invoice_ids": [
    "<string>"
  ],
  "customer_names_for_whom_order_is_prepared": [
    "<string>"
  ],
  "external_user_ids": [
    "<string>"
  ],
  "hazardous_details": "UN1845 - Dry ice",
  "on_behalf_of_client_id": "<string>",
  "on_behalf_of_user_id": "<string>",
  "refrigerated_details": "+2°C/+8°C",
  "total_commercial_invoice_amount": 123,
  "target_pickup_date": "2021-10-11",
  "packaging_done_at": "2021-10-11"
}
'

import requests

url = "localhost:///8080/v1/orderPreparations"

payload = {
    "instructions": {
        "should_label_packages": True,
        "should_palletise": True,
        "should_certify_commercial_invoices": True,
        "target_pickup_date": 123
    },
    "locations": {
        "preparing_warehouse_id": "<string>",
        "delivery_location_id": "<string>"
    },
    "name": "<string>",
    "owner_in_charge_of_moving_goods_in_fca_export": True,
    "picking_references": ["<string>"],
    "commercial_invoice_ids": ["<string>"],
    "customer_names_for_whom_order_is_prepared": ["<string>"],
    "external_user_ids": ["<string>"],
    "hazardous_details": "UN1845 - Dry ice",
    "on_behalf_of_client_id": "<string>",
    "on_behalf_of_user_id": "<string>",
    "refrigerated_details": "+2°C/+8°C",
    "total_commercial_invoice_amount": 123,
    "target_pickup_date": "2021-10-11",
    "packaging_done_at": "2021-10-11"
}
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({
    instructions: {
      should_label_packages: true,
      should_palletise: true,
      should_certify_commercial_invoices: true,
      target_pickup_date: 123
    },
    locations: {preparing_warehouse_id: '<string>', delivery_location_id: '<string>'},
    name: '<string>',
    owner_in_charge_of_moving_goods_in_fca_export: true,
    picking_references: ['<string>'],
    commercial_invoice_ids: ['<string>'],
    customer_names_for_whom_order_is_prepared: ['<string>'],
    external_user_ids: ['<string>'],
    hazardous_details: 'UN1845 - Dry ice',
    on_behalf_of_client_id: '<string>',
    on_behalf_of_user_id: '<string>',
    refrigerated_details: '+2°C/+8°C',
    total_commercial_invoice_amount: 123,
    target_pickup_date: '2021-10-11',
    packaging_done_at: '2021-10-11'
  })
};

fetch('localhost:///8080/v1/orderPreparations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "localhost:///8080/v1/orderPreparations",
  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([
    'instructions' => [
        'should_label_packages' => true,
        'should_palletise' => true,
        'should_certify_commercial_invoices' => true,
        'target_pickup_date' => 123
    ],
    'locations' => [
        'preparing_warehouse_id' => '<string>',
        'delivery_location_id' => '<string>'
    ],
    'name' => '<string>',
    'owner_in_charge_of_moving_goods_in_fca_export' => true,
    'picking_references' => [
        '<string>'
    ],
    'commercial_invoice_ids' => [
        '<string>'
    ],
    'customer_names_for_whom_order_is_prepared' => [
        '<string>'
    ],
    'external_user_ids' => [
        '<string>'
    ],
    'hazardous_details' => 'UN1845 - Dry ice',
    'on_behalf_of_client_id' => '<string>',
    'on_behalf_of_user_id' => '<string>',
    'refrigerated_details' => '+2°C/+8°C',
    'total_commercial_invoice_amount' => 123,
    'target_pickup_date' => '2021-10-11',
    'packaging_done_at' => '2021-10-11'
  ]),
  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 := "localhost:///8080/v1/orderPreparations"

	payload := strings.NewReader("{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\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("localhost:///8080/v1/orderPreparations")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("localhost:///8080/v1/orderPreparations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\n}"

response = http.request(request)
puts response.read_body

{
  "reference": "BIO-0008"
}

{}

Create an order preparation

curl --request POST \
  --url localhost:///8080/v1/orderPreparations \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": {
    "should_label_packages": true,
    "should_palletise": true,
    "should_certify_commercial_invoices": true,
    "target_pickup_date": 123
  },
  "locations": {
    "preparing_warehouse_id": "<string>",
    "delivery_location_id": "<string>"
  },
  "name": "<string>",
  "owner_in_charge_of_moving_goods_in_fca_export": true,
  "picking_references": [
    "<string>"
  ],
  "commercial_invoice_ids": [
    "<string>"
  ],
  "customer_names_for_whom_order_is_prepared": [
    "<string>"
  ],
  "external_user_ids": [
    "<string>"
  ],
  "hazardous_details": "UN1845 - Dry ice",
  "on_behalf_of_client_id": "<string>",
  "on_behalf_of_user_id": "<string>",
  "refrigerated_details": "+2°C/+8°C",
  "total_commercial_invoice_amount": 123,
  "target_pickup_date": "2021-10-11",
  "packaging_done_at": "2021-10-11"
}
'

import requests

url = "localhost:///8080/v1/orderPreparations"

payload = {
    "instructions": {
        "should_label_packages": True,
        "should_palletise": True,
        "should_certify_commercial_invoices": True,
        "target_pickup_date": 123
    },
    "locations": {
        "preparing_warehouse_id": "<string>",
        "delivery_location_id": "<string>"
    },
    "name": "<string>",
    "owner_in_charge_of_moving_goods_in_fca_export": True,
    "picking_references": ["<string>"],
    "commercial_invoice_ids": ["<string>"],
    "customer_names_for_whom_order_is_prepared": ["<string>"],
    "external_user_ids": ["<string>"],
    "hazardous_details": "UN1845 - Dry ice",
    "on_behalf_of_client_id": "<string>",
    "on_behalf_of_user_id": "<string>",
    "refrigerated_details": "+2°C/+8°C",
    "total_commercial_invoice_amount": 123,
    "target_pickup_date": "2021-10-11",
    "packaging_done_at": "2021-10-11"
}
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({
    instructions: {
      should_label_packages: true,
      should_palletise: true,
      should_certify_commercial_invoices: true,
      target_pickup_date: 123
    },
    locations: {preparing_warehouse_id: '<string>', delivery_location_id: '<string>'},
    name: '<string>',
    owner_in_charge_of_moving_goods_in_fca_export: true,
    picking_references: ['<string>'],
    commercial_invoice_ids: ['<string>'],
    customer_names_for_whom_order_is_prepared: ['<string>'],
    external_user_ids: ['<string>'],
    hazardous_details: 'UN1845 - Dry ice',
    on_behalf_of_client_id: '<string>',
    on_behalf_of_user_id: '<string>',
    refrigerated_details: '+2°C/+8°C',
    total_commercial_invoice_amount: 123,
    target_pickup_date: '2021-10-11',
    packaging_done_at: '2021-10-11'
  })
};

fetch('localhost:///8080/v1/orderPreparations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "localhost:///8080/v1/orderPreparations",
  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([
    'instructions' => [
        'should_label_packages' => true,
        'should_palletise' => true,
        'should_certify_commercial_invoices' => true,
        'target_pickup_date' => 123
    ],
    'locations' => [
        'preparing_warehouse_id' => '<string>',
        'delivery_location_id' => '<string>'
    ],
    'name' => '<string>',
    'owner_in_charge_of_moving_goods_in_fca_export' => true,
    'picking_references' => [
        '<string>'
    ],
    'commercial_invoice_ids' => [
        '<string>'
    ],
    'customer_names_for_whom_order_is_prepared' => [
        '<string>'
    ],
    'external_user_ids' => [
        '<string>'
    ],
    'hazardous_details' => 'UN1845 - Dry ice',
    'on_behalf_of_client_id' => '<string>',
    'on_behalf_of_user_id' => '<string>',
    'refrigerated_details' => '+2°C/+8°C',
    'total_commercial_invoice_amount' => 123,
    'target_pickup_date' => '2021-10-11',
    'packaging_done_at' => '2021-10-11'
  ]),
  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 := "localhost:///8080/v1/orderPreparations"

	payload := strings.NewReader("{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\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("localhost:///8080/v1/orderPreparations")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("localhost:///8080/v1/orderPreparations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": {\n    \"should_label_packages\": true,\n    \"should_palletise\": true,\n    \"should_certify_commercial_invoices\": true,\n    \"target_pickup_date\": 123\n  },\n  \"locations\": {\n    \"preparing_warehouse_id\": \"<string>\",\n    \"delivery_location_id\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"owner_in_charge_of_moving_goods_in_fca_export\": true,\n  \"picking_references\": [\n    \"<string>\"\n  ],\n  \"commercial_invoice_ids\": [\n    \"<string>\"\n  ],\n  \"customer_names_for_whom_order_is_prepared\": [\n    \"<string>\"\n  ],\n  \"external_user_ids\": [\n    \"<string>\"\n  ],\n  \"hazardous_details\": \"UN1845 - Dry ice\",\n  \"on_behalf_of_client_id\": \"<string>\",\n  \"on_behalf_of_user_id\": \"<string>\",\n  \"refrigerated_details\": \"+2°C/+8°C\",\n  \"total_commercial_invoice_amount\": 123,\n  \"target_pickup_date\": \"2021-10-11\",\n  \"packaging_done_at\": \"2021-10-11\"\n}"

response = http.request(request)
puts response.read_body

{
  "reference": "BIO-0008"
}

{}

Body

application/json

client_role_on_order

enum<string>

required

Available options:

buyer,

seller

instructions

object

required

Show child attributes

locations

object

required

Show child attributes

name

string

required

owner_in_charge_of_moving_goods_in_fca_export

boolean

required

picking_references

string[]

required

commercial_invoice_ids

string[]

customer_names_for_whom_order_is_prepared

string[]

external_user_ids

string[]

freight_method

enum<string>

Available options:

air,

ocean,

rail,

truck

incoterm

enum<string>

Available options:

cfr,

cif,

cip,

cpt,

dap,

dat,

ddp,

dpu,

exw,

fas,

fca,

fob

hazardous_details

string

Example:

"UN1845 - Dry ice"

on_behalf_of_client_id

string

on_behalf_of_user_id

string

refrigerated_details

string

Example:

"+2°C/+8°C"

total_commercial_invoice_amount

number

total_commercial_invoice_amount_currency

enum<string>

Available options:

AED,

AUD,

BHD,

BRL,

CAD,

CHF,

CNY,

EUR,

GBP,

HKD,

IDR,

INR,

JPY,

KRW,

KWD,

MXN,

MYR,

NZD,

PLN,

SEK,

SGD,

THB,

TWD,

USD,

XOF,

XPF,

ZAR

target_pickup_date

string

Example:

"2021-10-11"

packaging_done_at

string

Example:

"2021-10-11"

Response

Order preparation created

reference

string

Getting Started

Endpoints

Data Models

Create an order preparation

Body

Response