Create a return shipment intent
curl --request POST \
--url https://api.getprimo.com/return-shipment-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offboardingId": "<string>",
"fromAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"toAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"createBoxShipment": true,
"parcel": {
"weight": 10050,
"length": 505,
"width": 505,
"height": 505
},
"hasInsurance": true,
"value": 4503599627370495,
"content": [
{
"name": "<string>",
"id": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": [
"<string>"
],
"comment": "<string>",
"parentTicketId": "<string>"
}
'import requests
url = "https://api.getprimo.com/return-shipment-intents"
payload = {
"offboardingId": "<string>",
"fromAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"toAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"createBoxShipment": True,
"parcel": {
"weight": 10050,
"length": 505,
"width": 505,
"height": 505
},
"hasInsurance": True,
"value": 4503599627370495,
"content": [
{
"name": "<string>",
"id": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": ["<string>"],
"comment": "<string>",
"parentTicketId": "<string>"
}
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({
offboardingId: '<string>',
fromAddress: {
street: '<string>',
postalCode: '<string>',
city: '<string>',
name: '<string>',
contactName: '<string>',
phone: '<string>',
complement: '<string>',
country: '<string>',
countryCode: '<string>'
},
toAddress: {
street: '<string>',
postalCode: '<string>',
city: '<string>',
name: '<string>',
contactName: '<string>',
phone: '<string>',
complement: '<string>',
country: '<string>',
countryCode: '<string>'
},
createBoxShipment: true,
parcel: {weight: 10050, length: 505, width: 505, height: 505},
hasInsurance: true,
value: 4503599627370495,
content: [{name: '<string>', id: '<string>', type: '<string>'}],
billingProfileId: '<string>',
notificationEmails: ['<string>'],
comment: '<string>',
parentTicketId: '<string>'
})
};
fetch('https://api.getprimo.com/return-shipment-intents', 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.getprimo.com/return-shipment-intents",
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([
'offboardingId' => '<string>',
'fromAddress' => [
'street' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'name' => '<string>',
'contactName' => '<string>',
'phone' => '<string>',
'complement' => '<string>',
'country' => '<string>',
'countryCode' => '<string>'
],
'toAddress' => [
'street' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'name' => '<string>',
'contactName' => '<string>',
'phone' => '<string>',
'complement' => '<string>',
'country' => '<string>',
'countryCode' => '<string>'
],
'createBoxShipment' => true,
'parcel' => [
'weight' => 10050,
'length' => 505,
'width' => 505,
'height' => 505
],
'hasInsurance' => true,
'value' => 4503599627370495,
'content' => [
[
'name' => '<string>',
'id' => '<string>',
'type' => '<string>'
]
],
'billingProfileId' => '<string>',
'notificationEmails' => [
'<string>'
],
'comment' => '<string>',
'parentTicketId' => '<string>'
]),
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.getprimo.com/return-shipment-intents"
payload := strings.NewReader("{\n \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\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.getprimo.com/return-shipment-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getprimo.com/return-shipment-intents")
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 \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"taskId": "<string>",
"ticketId": "<string>",
"offboardingId": "<string>",
"executedAt": "2023-11-07T05:31:56Z",
"fromAddress": {
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"street": "<string>",
"complement": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"type": "HOME"
},
"toAddress": {
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"street": "<string>",
"complement": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"type": "HOME"
},
"createBoxShipment": true,
"parcel": {
"weight": 123,
"length": 123,
"width": 123,
"height": 123
},
"hasInsurance": true,
"value": 123,
"content": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": [
"<string>"
],
"comment": "<string>",
"shipmentId": "<string>"
}Offboardings
Create a return shipment intent
Create the RETURN_SHIPMENT task of an offboarding: the parcel that brings the leaver devices back. The device handling usually opens it on execute; create one only when it did not. A field you leave out is pre-filled from the leaver, the company and the device handling. The intent holds the createShipment input: the pickup address (the leaver home by default), the destination (the company first address by default), the parcel, the declared value, the content, the billing profile (getBillingProfiles). Returns the intent id, its taskId and the ticketId holding it. The task cannot be marked done by hand: updateTaskStatus refuses it with TaskLockedByTypeError, and it completes when the intent executes. The offboarding opens this task itself (createOffboarding); its intentId is on the task (getTicket). Create one only for a step the offboarding did not open. createTicket and createTask cannot make a typed task. Refused with OFFBOARDING_NOT_FOUND, PARENT_TICKET_NOT_FOUND, PARENT_TICKET_IS_TYPED or PARENT_TICKET_IS_A_TASK (pass the untyped ticket instead), OFFBOARDING_NOT_OPEN, BILLING_PROFILE_NOT_FOUND.
POST
/
return-shipment-intents
Create a return shipment intent
curl --request POST \
--url https://api.getprimo.com/return-shipment-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offboardingId": "<string>",
"fromAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"toAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"createBoxShipment": true,
"parcel": {
"weight": 10050,
"length": 505,
"width": 505,
"height": 505
},
"hasInsurance": true,
"value": 4503599627370495,
"content": [
{
"name": "<string>",
"id": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": [
"<string>"
],
"comment": "<string>",
"parentTicketId": "<string>"
}
'import requests
url = "https://api.getprimo.com/return-shipment-intents"
payload = {
"offboardingId": "<string>",
"fromAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"toAddress": {
"street": "<string>",
"postalCode": "<string>",
"city": "<string>",
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"complement": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"createBoxShipment": True,
"parcel": {
"weight": 10050,
"length": 505,
"width": 505,
"height": 505
},
"hasInsurance": True,
"value": 4503599627370495,
"content": [
{
"name": "<string>",
"id": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": ["<string>"],
"comment": "<string>",
"parentTicketId": "<string>"
}
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({
offboardingId: '<string>',
fromAddress: {
street: '<string>',
postalCode: '<string>',
city: '<string>',
name: '<string>',
contactName: '<string>',
phone: '<string>',
complement: '<string>',
country: '<string>',
countryCode: '<string>'
},
toAddress: {
street: '<string>',
postalCode: '<string>',
city: '<string>',
name: '<string>',
contactName: '<string>',
phone: '<string>',
complement: '<string>',
country: '<string>',
countryCode: '<string>'
},
createBoxShipment: true,
parcel: {weight: 10050, length: 505, width: 505, height: 505},
hasInsurance: true,
value: 4503599627370495,
content: [{name: '<string>', id: '<string>', type: '<string>'}],
billingProfileId: '<string>',
notificationEmails: ['<string>'],
comment: '<string>',
parentTicketId: '<string>'
})
};
fetch('https://api.getprimo.com/return-shipment-intents', 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.getprimo.com/return-shipment-intents",
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([
'offboardingId' => '<string>',
'fromAddress' => [
'street' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'name' => '<string>',
'contactName' => '<string>',
'phone' => '<string>',
'complement' => '<string>',
'country' => '<string>',
'countryCode' => '<string>'
],
'toAddress' => [
'street' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'name' => '<string>',
'contactName' => '<string>',
'phone' => '<string>',
'complement' => '<string>',
'country' => '<string>',
'countryCode' => '<string>'
],
'createBoxShipment' => true,
'parcel' => [
'weight' => 10050,
'length' => 505,
'width' => 505,
'height' => 505
],
'hasInsurance' => true,
'value' => 4503599627370495,
'content' => [
[
'name' => '<string>',
'id' => '<string>',
'type' => '<string>'
]
],
'billingProfileId' => '<string>',
'notificationEmails' => [
'<string>'
],
'comment' => '<string>',
'parentTicketId' => '<string>'
]),
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.getprimo.com/return-shipment-intents"
payload := strings.NewReader("{\n \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\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.getprimo.com/return-shipment-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getprimo.com/return-shipment-intents")
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 \"offboardingId\": \"<string>\",\n \"fromAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"toAddress\": {\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"name\": \"<string>\",\n \"contactName\": \"<string>\",\n \"phone\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"createBoxShipment\": true,\n \"parcel\": {\n \"weight\": 10050,\n \"length\": 505,\n \"width\": 505,\n \"height\": 505\n },\n \"hasInsurance\": true,\n \"value\": 4503599627370495,\n \"content\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"billingProfileId\": \"<string>\",\n \"notificationEmails\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"parentTicketId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"taskId": "<string>",
"ticketId": "<string>",
"offboardingId": "<string>",
"executedAt": "2023-11-07T05:31:56Z",
"fromAddress": {
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"street": "<string>",
"complement": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"type": "HOME"
},
"toAddress": {
"name": "<string>",
"contactName": "<string>",
"phone": "<string>",
"street": "<string>",
"complement": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"countryCode": "<string>",
"type": "HOME"
},
"createBoxShipment": true,
"parcel": {
"weight": 123,
"length": 123,
"width": 123,
"height": 123
},
"hasInsurance": true,
"value": 123,
"content": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"billingProfileId": "<string>",
"notificationEmails": [
"<string>"
],
"comment": "<string>",
"shipmentId": "<string>"
}Key: Write
Scope: Company
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Body
application/json
The offboarding this step belongs to, from getOffboardings
Pattern:
^[a-f\d]{24}$Where the parcel is picked up, by default the leaver's address
Show child attributes
Show child attributes
Where it goes, by default the company's first address
Show child attributes
Show child attributes
Send a Primo box to the leaver first
Show child attributes
Show child attributes
Declared value of the content, in cents: 150000 for €1,500
Required range:
0 < x <= 9007199254740991What goes back; replaced whole
Show child attributes
Show child attributes
From getBillingProfiles
Pattern:
^[a-f\d]{24}$Minimum string length:
1The ticket to hold the task. Defaults to the offboarding ticket; never a typed task.
Pattern:
^[a-f\d]{24}$Response
default - application/json
Intent id, to pass to its update and execute tools
The typed task that tracks this step
The ticket holding that task, usually the offboarding ticket. Null if it could not be read back.
When the intent executed; null until then
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Declared value, in cents
Show child attributes
Show child attributes
The shipment created on execute, to read with getShipment
⌘I