Create a new shipment
curl --request POST \
--url https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"locationReference": "<string>",
"externalReference": "<string>",
"code": "<string>",
"date": "2023-12-25",
"shipImmediately": true
}
'import requests
url = "https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment"
payload = {
"locationReference": "<string>",
"externalReference": "<string>",
"code": "<string>",
"date": "2023-12-25",
"shipImmediately": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
locationReference: '<string>',
externalReference: '<string>',
code: '<string>',
date: '2023-12-25',
shipImmediately: true
})
};
fetch('https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment', 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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment",
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([
'locationReference' => '<string>',
'externalReference' => '<string>',
'code' => '<string>',
'date' => '2023-12-25',
'shipImmediately' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment"
payload := strings.NewReader("{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"externalReference": "<string>",
"destination": "<string>",
"destinationId": "<string>",
"type": "Customer",
"status": "Pending",
"date": "2023-12-25",
"code": "<string>",
"locationId": "<string>",
"loadOrderId": "<string>",
"linkedToLoadOrder": true,
"location": {
"id": "<string>",
"externalReference": "<string>",
"name": "<string>",
"kind": "Storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"loadOrder": {
"id": "<string>",
"name": "<string>",
"externalReference": "<string>",
"status": "Draft",
"loadLocationId": "<string>",
"transportId": "<string>",
"loadLocation": {
"id": "<string>",
"externalReference": "<string>",
"name": "<string>",
"kind": "Storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"transport": {
"id": "<string>",
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"plannedAt": "2023-11-07T05:31:56Z",
"materialRequestStatus": "NotRequested",
"materialsRequestedAt": "2023-11-07T05:31:56Z",
"provisioningStatus": "Pending",
"provisionedQuantity": 123,
"provisioningIncomingQuantity": 123,
"requiresValidation": true,
"validationStatus": "Unvalidated",
"requiredQuantity": 123,
"validatedQuantity": 123,
"loadingStartedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"shipmentId": "<string>",
"shipmentLineId": "<string>",
"relatedId": "<string>",
"skuId": "<string>",
"requiredLotId": "<string>",
"quantity": 123,
"provisioningStatus": "Pending",
"provisionedQuantity": 123,
"incomingQuantity": 123,
"type": "SalesOrderLine"
}
],
"validationEntries": [
{
"id": "<string>",
"shipmentId": "<string>",
"skuId": "<string>",
"lotId": "<string>",
"quantity": 123,
"containerId": "<string>",
"validatedAt": "2023-11-07T05:31:56Z",
"validatedByEmployeeId": "<string>"
}
],
"timeEntries": [
{
"id": "<string>",
"employeeId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z"
}
],
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"shipped": true,
"shippedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
}{
"type": "https://api.bold-factory.com/errors/COMMON.QUERY.FILTER_PARSING_FAILED",
"title": "Filter parsing failed",
"status": 400,
"detail": "The filter string could not be parsed or contains invalid column references: CreatedBy column does not exist.",
"instance": "POST /v1/items/families/search",
"code": "COMMON.QUERY.FILTER_PARSING_FAILED"
}{
"type": "https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "You are not authenticated.",
"instance": "GET /v1/items/skus"
}{
"type": "https://api.bold-factory.com/errors/COMMON.AUTH.MISSING_PERMISSIONS",
"title": "Missing permissions",
"status": 403,
"detail": "Missing permissions: Items.Families.Read",
"instance": "GET /v1/maintenance/assets",
"code": "COMMON.AUTH.MISSING_PERMISSIONS"
}{
"type": "https://api.bold-factory.com/errors/PLANNING.PURCHASE_ORDER.CANNOT_MODIFY_CANCELLED_LINE",
"title": "Cannot modify cancelled line",
"status": 422,
"detail": "A cancelled line can't be modified.",
"instance": "PUT /v1/planning/purchaseOrders/po_sd786f78s78hgf8hg/lines/pol_n7893ytw3et7w4wfo5rf",
"code": "PLANNING.PURCHASE_ORDER.CANNOT_MODIFY_CANCELLED_LINE"
}{
"type": "https://api.bold-factory.com/errors/COMMON.RATE_LIMIT.EXCEEDED",
"title": "Rate limit exceeded",
"status": 429,
"detail": "The request rate limit for this tenant has been exceeded. Retry after the indicated delay.",
"instance": "GET /v1/admin/tenants/self",
"code": "COMMON.RATE_LIMIT.EXCEEDED",
"parameters": {}
}Shipments
Create a new shipment
Requires Warehouse.Shipments.Write permissions
POST
/
v1
/
planning
/
salesOrders
/
{orderReference}
/
shipment
Create a new shipment
curl --request POST \
--url https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"locationReference": "<string>",
"externalReference": "<string>",
"code": "<string>",
"date": "2023-12-25",
"shipImmediately": true
}
'import requests
url = "https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment"
payload = {
"locationReference": "<string>",
"externalReference": "<string>",
"code": "<string>",
"date": "2023-12-25",
"shipImmediately": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
locationReference: '<string>',
externalReference: '<string>',
code: '<string>',
date: '2023-12-25',
shipImmediately: true
})
};
fetch('https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment', 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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment",
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([
'locationReference' => '<string>',
'externalReference' => '<string>',
'code' => '<string>',
'date' => '2023-12-25',
'shipImmediately' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment"
payload := strings.NewReader("{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bold-factory.com/v1/planning/salesOrders/{orderReference}/shipment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationReference\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"code\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"shipImmediately\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"externalReference": "<string>",
"destination": "<string>",
"destinationId": "<string>",
"type": "Customer",
"status": "Pending",
"date": "2023-12-25",
"code": "<string>",
"locationId": "<string>",
"loadOrderId": "<string>",
"linkedToLoadOrder": true,
"location": {
"id": "<string>",
"externalReference": "<string>",
"name": "<string>",
"kind": "Storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"loadOrder": {
"id": "<string>",
"name": "<string>",
"externalReference": "<string>",
"status": "Draft",
"loadLocationId": "<string>",
"transportId": "<string>",
"loadLocation": {
"id": "<string>",
"externalReference": "<string>",
"name": "<string>",
"kind": "Storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"transport": {
"id": "<string>",
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"plannedAt": "2023-11-07T05:31:56Z",
"materialRequestStatus": "NotRequested",
"materialsRequestedAt": "2023-11-07T05:31:56Z",
"provisioningStatus": "Pending",
"provisionedQuantity": 123,
"provisioningIncomingQuantity": 123,
"requiresValidation": true,
"validationStatus": "Unvalidated",
"requiredQuantity": 123,
"validatedQuantity": 123,
"loadingStartedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"shipmentId": "<string>",
"shipmentLineId": "<string>",
"relatedId": "<string>",
"skuId": "<string>",
"requiredLotId": "<string>",
"quantity": 123,
"provisioningStatus": "Pending",
"provisionedQuantity": 123,
"incomingQuantity": 123,
"type": "SalesOrderLine"
}
],
"validationEntries": [
{
"id": "<string>",
"shipmentId": "<string>",
"skuId": "<string>",
"lotId": "<string>",
"quantity": 123,
"containerId": "<string>",
"validatedAt": "2023-11-07T05:31:56Z",
"validatedByEmployeeId": "<string>"
}
],
"timeEntries": [
{
"id": "<string>",
"employeeId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z"
}
],
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"shipped": true,
"shippedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
}{
"type": "https://api.bold-factory.com/errors/COMMON.QUERY.FILTER_PARSING_FAILED",
"title": "Filter parsing failed",
"status": 400,
"detail": "The filter string could not be parsed or contains invalid column references: CreatedBy column does not exist.",
"instance": "POST /v1/items/families/search",
"code": "COMMON.QUERY.FILTER_PARSING_FAILED"
}{
"type": "https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "You are not authenticated.",
"instance": "GET /v1/items/skus"
}{
"type": "https://api.bold-factory.com/errors/COMMON.AUTH.MISSING_PERMISSIONS",
"title": "Missing permissions",
"status": 403,
"detail": "Missing permissions: Items.Families.Read",
"instance": "GET /v1/maintenance/assets",
"code": "COMMON.AUTH.MISSING_PERMISSIONS"
}{
"type": "https://api.bold-factory.com/errors/PLANNING.PURCHASE_ORDER.CANNOT_MODIFY_CANCELLED_LINE",
"title": "Cannot modify cancelled line",
"status": 422,
"detail": "A cancelled line can't be modified.",
"instance": "PUT /v1/planning/purchaseOrders/po_sd786f78s78hgf8hg/lines/pol_n7893ytw3et7w4wfo5rf",
"code": "PLANNING.PURCHASE_ORDER.CANNOT_MODIFY_CANCELLED_LINE"
}{
"type": "https://api.bold-factory.com/errors/COMMON.RATE_LIMIT.EXCEEDED",
"title": "Rate limit exceeded",
"status": 429,
"detail": "The request rate limit for this tenant has been exceeded. Retry after the indicated delay.",
"instance": "GET /v1/admin/tenants/self",
"code": "COMMON.RATE_LIMIT.EXCEEDED",
"parameters": {}
}Authorizations
JWTApiKey
Use a valid JWT token in the Authorization header with the format 'Bearer {token}'
Path Parameters
Body
application/json
Response
Created
Available options:
Customer, Supplier Available options:
Pending, Shipped, Cancelled Show child attributes
Show child attributes
Show child attributes
Show child attributes