cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/item_fulfillments" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item_fulfillment": {
"invoice_id": "INV-0001",
"fulfillments": [
{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1
}
]
}
}'from exsited import build_client
client = build_client()
response = client.item_fulfillments.create_item_fulfillment(
{
"item_fulfillment": {
"invoice_id": "INV-0001",
"fulfillments": [
{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1,
}
],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.itemFulfillments.createItemFulfillment({
item_fulfillment: {
invoice_id: 'INV-0001',
fulfillments: [{invoice_line: '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', fulfillment_quantity: 1}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->itemFulfillments->createItemFulfillment([
'item_fulfillment' => [
'invoice_id' => 'INV-0001',
'fulfillments' => [
['invoice_line' => '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', 'fulfillment_quantity' => 1],
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.item_fulfillments.item_fulfillments_dto.ItemFulfillmentsDto;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ItemFulfillmentsDto.ItemFulfillments> response = client.itemFulfillments().createItemFulfillment(
Map.of(
"item_fulfillment", Map.of(
"invoice_id", "INV-0001",
"fulfillments", List.of(
Map.of(
"invoice_line", "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity", 1)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ItemFulfillments.CreateItemFulfillmentAsync(new Dictionary<string, object?>
{
["item_fulfillment"] = new Dictionary<string, object?>
{
["invoice_id"] = "INV-0001",
["fulfillments"] = new List<object?>
{
new Dictionary<string, object?>
{
["invoice_line"] = "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
["fulfillment_quantity"] = 1,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.itemFulfillments.createItemFulfillment({
'item_fulfillment': {
'invoice_id': 'INV-0001',
'fulfillments': [
{
'invoice_line': '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0',
'fulfillment_quantity': 1,
},
],
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.ItemFulfillments().CreateItemFulfillment(context.Background(), map[string]any{
"item_fulfillment": map[string]any{
"invoice_id": "INV-0001",
"fulfillments": []any{
map[string]any{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1,
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item_fulfillment": {
"activity_logs": "<array>",
"code": "<string>",
"fulfillment_date": "<string>",
"fulfillment_note": "<string>",
"fulfillment_status": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>",
"status": "<string>",
"version": 123
}
}Item fulfillments
Create an item fulfillment
Records items sent against a sale invoice’s lines and returns the fulfillment.
POST
/
item_fulfillments
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/item_fulfillments" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item_fulfillment": {
"invoice_id": "INV-0001",
"fulfillments": [
{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1
}
]
}
}'from exsited import build_client
client = build_client()
response = client.item_fulfillments.create_item_fulfillment(
{
"item_fulfillment": {
"invoice_id": "INV-0001",
"fulfillments": [
{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1,
}
],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.itemFulfillments.createItemFulfillment({
item_fulfillment: {
invoice_id: 'INV-0001',
fulfillments: [{invoice_line: '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', fulfillment_quantity: 1}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->itemFulfillments->createItemFulfillment([
'item_fulfillment' => [
'invoice_id' => 'INV-0001',
'fulfillments' => [
['invoice_line' => '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', 'fulfillment_quantity' => 1],
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.item_fulfillments.item_fulfillments_dto.ItemFulfillmentsDto;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ItemFulfillmentsDto.ItemFulfillments> response = client.itemFulfillments().createItemFulfillment(
Map.of(
"item_fulfillment", Map.of(
"invoice_id", "INV-0001",
"fulfillments", List.of(
Map.of(
"invoice_line", "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity", 1)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ItemFulfillments.CreateItemFulfillmentAsync(new Dictionary<string, object?>
{
["item_fulfillment"] = new Dictionary<string, object?>
{
["invoice_id"] = "INV-0001",
["fulfillments"] = new List<object?>
{
new Dictionary<string, object?>
{
["invoice_line"] = "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
["fulfillment_quantity"] = 1,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.itemFulfillments.createItemFulfillment({
'item_fulfillment': {
'invoice_id': 'INV-0001',
'fulfillments': [
{
'invoice_line': '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0',
'fulfillment_quantity': 1,
},
],
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.ItemFulfillments().CreateItemFulfillment(context.Background(), map[string]any{
"item_fulfillment": map[string]any{
"invoice_id": "INV-0001",
"fulfillments": []any{
map[string]any{
"invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
"fulfillment_quantity": 1,
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item_fulfillment": {
"activity_logs": "<array>",
"code": "<string>",
"fulfillment_date": "<string>",
"fulfillment_note": "<string>",
"fulfillment_status": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>",
"status": "<string>",
"version": 123
}
}Send the fulfillment under
item_fulfillment: the invoice_id, and fulfillments listing each invoice line by its id in invoice_line with the fulfillment_quantity sent. The new fulfillment comes back under item_fulfillment with fulfillment_status shipped.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Body
application/json
Show child attributes
Show child attributes
Response
201 - application/json
The new fulfillment, under item_fulfillment.
Show child attributes
Show child attributes