cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/items" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item": {
"type": "STANDARD",
"name": "Acme Widget"
}
}'from exsited import build_client
client = build_client()
response = client.items.create_item(
{"item": {"type": "STANDARD", "name": "Acme Widget"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.items.createItem({item: {type: 'STANDARD', name: 'Acme Widget'}});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->items->createItem(['item' => ['type' => 'STANDARD', 'name' => 'Acme Widget']]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.items.items_dto.ItemsDto.Item;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Item> response = client.items().createItem(
Map.of("item", Map.of("type", "STANDARD", "name", "Acme Widget")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Items.CreateItemAsync(new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["type"] = "STANDARD",
["name"] = "Acme Widget",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.items.createItem({
'item': {'type': 'STANDARD', 'name': 'Acme Widget'},
});
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.Items().CreateItem(context.Background(), map[string]any{
"item": map[string]any{"type": "STANDARD", "name": "Acme Widget"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"type": "<string>",
"status": "<string>",
"origin": "<string>",
"invoice_note": "<string>",
"version": 123,
"href": "<string>",
"sale_enabled": true,
"purchase_enabled": true,
"inventory_enabled": true,
"variations_enabled": true,
"parent": true,
"child": true,
"parent_item_id": "<string>",
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"manager": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"group": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"created_on": "<string>",
"created_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"last_updated_on": "<string>",
"last_updated_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"codes": [
{
"name": "<string>",
"value": "<string>"
}
],
"currencies": [
{
"name": "<string>",
"used_for_sale": true,
"default_for_sale": true,
"used_for_purchase": true,
"default_for_purchase": true,
"suppliers": "<array>"
}
],
"sale": {
"enabled": true,
"enable_back_order": true,
"invoice_note": "<string>",
"default_sale_price": 123,
"pricing_method": "<string>",
"sale_price_variant": "<string>",
"use_on_sale_price": true,
"tax_exempt_when_sold": true,
"tax_configuration": {
"sale_price_entered_inclusive_of_tax": true,
"purchase_price_entered_inclusive_of_tax": true,
"sale_price_based_on": "<string>",
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"charge": {
"type": "<string>",
"price_period": "<string>",
"properties": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"pricing_levels": [
{
"name": "<string>",
"uuid": "<string>"
}
],
"pricing_schedules": "<array>",
"payment_properties": [
{
"name": "<string>",
"value": "<string>"
}
],
"accounting_code": "<unknown>",
"discount_profile": "<unknown>",
"pricing_profile": "<unknown>",
"shipping_profile": "<unknown>",
"sale_price": "<unknown>",
"start_date": "<unknown>",
"end_date": "<unknown>",
"height": {
"uom": "<string>",
"value": 123
},
"length": {
"uom": "<string>",
"value": 123
},
"weight": {
"uom": "<string>",
"value": 123
},
"width": {
"uom": "<string>",
"value": 123
}
},
"purchase": {
"enabled": true,
"supplier_management_enabled": true,
"purchase_order_note": "<string>",
"default_purchase_price": 123,
"tax_exempt_when_purchase": true,
"tax_configuration": {
"sale_price_entered_inclusive_of_tax": true,
"purchase_price_entered_inclusive_of_tax": true,
"sale_price_based_on": "<string>",
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"purchase_properties": [
{
"name": "<string>",
"value": "<string>"
}
],
"accounting_code": "<unknown>",
"pricing_profile": "<unknown>",
"suppliers": [
{
"accounting_code": "<unknown>",
"default_purchase_price": 123,
"id": "<unknown>",
"name": "<string>",
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"purchase_order_note": "<unknown>",
"tax_configuration": {
"purchase_price_entered_inclusive_of_tax": true,
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"tax_exempt_when_purchase": true
}
]
},
"inventories": {
"enabled": true,
"enable_warehouse_management": true,
"default_warehouse": "<string>",
"inventory_properties": {
"enabled": true,
"enable_batch_tracking": true,
"enable_serialization": true,
"enable_inventory_costing": true,
"enable_low_stock_notification": true,
"enable_preorder": true,
"enable_reordering": true,
"low_stock_threshold_based_on": "<string>",
"reordering_threshold_based_on": "<string>",
"quantity_available_for_sale": "<string>",
"quantity_available_for_sale_determination": "<array>",
"use_atp_value_as_quantity_available_for_webhook": true,
"default_cost_per_unit": "<unknown>",
"preorder_configuration": [
{
"end_date": "<string>",
"name": "<string>",
"start_date": "<string>"
}
],
"preorder_period": "<string>"
},
"warehouses": [
{
"quantity_on_hand": 123,
"quantity_on_hand_value": "<string>",
"quantity_available": 123,
"quantity_available_value": "<string>",
"quantity_on_order": 123,
"quantity_promised": 123,
"quantity_on_return": 123,
"quantity_on_purchase_return": 123,
"warehouse": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"uom": "<string>"
}
]
},
"bundle_details": [
{
"id": "<string>",
"name": "<string>",
"quantity": 123,
"uom": "<string>"
}
],
"family_details": [
{
"item_id": "<string>",
"item_name": "<string>"
}
],
"package_details": [
{
"object": "<string>",
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"display_name": "<string>",
"status": "<string>",
"rank": 123,
"items": [
{
"item_id": "<string>",
"item_name": "<string>",
"quantity": 123,
"uom": "<unknown>"
}
],
"billing_periods": [
{
"name": "<string>",
"rank": 123
}
],
"custom_attributes": "<array>",
"created_on": "<string>",
"created_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"last_updated_on": "<unknown>",
"last_updated_by": "<unknown>"
}
],
"configure_variations": [
{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>",
"values": [
{
"name": "<string>",
"uuid": "<string>"
}
]
}
],
"use_variations": [
{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>",
"values": [
{
"name": "<string>",
"uuid": "<string>"
}
]
}
],
"custom_objects": "<array>",
"uoms": "<array>",
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"activity_logs": "<array>",
"base_uom": "<unknown>",
"image_url": "<unknown>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Items
Create an item
Creates an item and returns it under item.
POST
/
items
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/items" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item": {
"type": "STANDARD",
"name": "Acme Widget"
}
}'from exsited import build_client
client = build_client()
response = client.items.create_item(
{"item": {"type": "STANDARD", "name": "Acme Widget"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.items.createItem({item: {type: 'STANDARD', name: 'Acme Widget'}});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->items->createItem(['item' => ['type' => 'STANDARD', 'name' => 'Acme Widget']]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.items.items_dto.ItemsDto.Item;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Item> response = client.items().createItem(
Map.of("item", Map.of("type", "STANDARD", "name", "Acme Widget")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Items.CreateItemAsync(new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["type"] = "STANDARD",
["name"] = "Acme Widget",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.items.createItem({
'item': {'type': 'STANDARD', 'name': 'Acme Widget'},
});
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.Items().CreateItem(context.Background(), map[string]any{
"item": map[string]any{"type": "STANDARD", "name": "Acme Widget"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"type": "<string>",
"status": "<string>",
"origin": "<string>",
"invoice_note": "<string>",
"version": 123,
"href": "<string>",
"sale_enabled": true,
"purchase_enabled": true,
"inventory_enabled": true,
"variations_enabled": true,
"parent": true,
"child": true,
"parent_item_id": "<string>",
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"manager": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"group": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"created_on": "<string>",
"created_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"last_updated_on": "<string>",
"last_updated_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"codes": [
{
"name": "<string>",
"value": "<string>"
}
],
"currencies": [
{
"name": "<string>",
"used_for_sale": true,
"default_for_sale": true,
"used_for_purchase": true,
"default_for_purchase": true,
"suppliers": "<array>"
}
],
"sale": {
"enabled": true,
"enable_back_order": true,
"invoice_note": "<string>",
"default_sale_price": 123,
"pricing_method": "<string>",
"sale_price_variant": "<string>",
"use_on_sale_price": true,
"tax_exempt_when_sold": true,
"tax_configuration": {
"sale_price_entered_inclusive_of_tax": true,
"purchase_price_entered_inclusive_of_tax": true,
"sale_price_based_on": "<string>",
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"charge": {
"type": "<string>",
"price_period": "<string>",
"properties": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"pricing_levels": [
{
"name": "<string>",
"uuid": "<string>"
}
],
"pricing_schedules": "<array>",
"payment_properties": [
{
"name": "<string>",
"value": "<string>"
}
],
"accounting_code": "<unknown>",
"discount_profile": "<unknown>",
"pricing_profile": "<unknown>",
"shipping_profile": "<unknown>",
"sale_price": "<unknown>",
"start_date": "<unknown>",
"end_date": "<unknown>",
"height": {
"uom": "<string>",
"value": 123
},
"length": {
"uom": "<string>",
"value": 123
},
"weight": {
"uom": "<string>",
"value": 123
},
"width": {
"uom": "<string>",
"value": 123
}
},
"purchase": {
"enabled": true,
"supplier_management_enabled": true,
"purchase_order_note": "<string>",
"default_purchase_price": 123,
"tax_exempt_when_purchase": true,
"tax_configuration": {
"sale_price_entered_inclusive_of_tax": true,
"purchase_price_entered_inclusive_of_tax": true,
"sale_price_based_on": "<string>",
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"purchase_properties": [
{
"name": "<string>",
"value": "<string>"
}
],
"accounting_code": "<unknown>",
"pricing_profile": "<unknown>",
"suppliers": [
{
"accounting_code": "<unknown>",
"default_purchase_price": 123,
"id": "<unknown>",
"name": "<string>",
"pricing": {
"type": "<string>",
"version": 123,
"latest_used_pricing_version": 123,
"pricing_module": [
{
"average_purchase_price": "<unknown>",
"currency": "<string>",
"last_purchase_price": "<unknown>",
"price": 123,
"price_type": "<string>",
"pricing_level": "<string>",
"unit": "<string>"
}
]
},
"purchase_order_note": "<unknown>",
"tax_configuration": {
"purchase_price_entered_inclusive_of_tax": true,
"tax_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
}
},
"tax_exempt_when_purchase": true
}
]
},
"inventories": {
"enabled": true,
"enable_warehouse_management": true,
"default_warehouse": "<string>",
"inventory_properties": {
"enabled": true,
"enable_batch_tracking": true,
"enable_serialization": true,
"enable_inventory_costing": true,
"enable_low_stock_notification": true,
"enable_preorder": true,
"enable_reordering": true,
"low_stock_threshold_based_on": "<string>",
"reordering_threshold_based_on": "<string>",
"quantity_available_for_sale": "<string>",
"quantity_available_for_sale_determination": "<array>",
"use_atp_value_as_quantity_available_for_webhook": true,
"default_cost_per_unit": "<unknown>",
"preorder_configuration": [
{
"end_date": "<string>",
"name": "<string>",
"start_date": "<string>"
}
],
"preorder_period": "<string>"
},
"warehouses": [
{
"quantity_on_hand": 123,
"quantity_on_hand_value": "<string>",
"quantity_available": 123,
"quantity_available_value": "<string>",
"quantity_on_order": 123,
"quantity_promised": 123,
"quantity_on_return": 123,
"quantity_on_purchase_return": 123,
"warehouse": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"uom": "<string>"
}
]
},
"bundle_details": [
{
"id": "<string>",
"name": "<string>",
"quantity": 123,
"uom": "<string>"
}
],
"family_details": [
{
"item_id": "<string>",
"item_name": "<string>"
}
],
"package_details": [
{
"object": "<string>",
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"display_name": "<string>",
"status": "<string>",
"rank": 123,
"items": [
{
"item_id": "<string>",
"item_name": "<string>",
"quantity": 123,
"uom": "<unknown>"
}
],
"billing_periods": [
{
"name": "<string>",
"rank": 123
}
],
"custom_attributes": "<array>",
"created_on": "<string>",
"created_by": {
"object": "<string>",
"name": "<string>",
"id": "<string>",
"email": "<string>",
"href": "<string>"
},
"last_updated_on": "<unknown>",
"last_updated_by": "<unknown>"
}
],
"configure_variations": [
{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>",
"values": [
{
"name": "<string>",
"uuid": "<string>"
}
]
}
],
"use_variations": [
{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>",
"values": [
{
"name": "<string>",
"uuid": "<string>"
}
]
}
],
"custom_objects": "<array>",
"uoms": "<array>",
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"activity_logs": "<array>",
"base_uom": "<unknown>",
"image_url": "<unknown>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Send the item under
item. type and name are the minimum. A bundle lists its components in bundle_details, each with an id and a quantity; a variation parent sends is_parent: true, and a child sends is_child: true with the parent’s parent_item_id.
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.