cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/items/ITEM-0001/sale" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.items.get_item_sale("ITEM-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.items.getItemSale('ITEM-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->items->getItemSale('ITEM-0001');
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.ItemSaleView;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ItemSaleView> response = client.items().getItemSale("ITEM-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Items.GetItemSaleAsync("ITEM-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.items.getItemSale('ITEM-0001');
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().GetItemSale(context.Background(), "ITEM-0001", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item": {
"id": 123,
"name": "<string>",
"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
}
}
}
}Items
Retrieve an item's sale settings
Returns an item’s sale section in a short item with id, name and sale.
GET
/
items
/
{item_id}
/
sale
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/items/ITEM-0001/sale" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.items.get_item_sale("ITEM-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.items.getItemSale('ITEM-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->items->getItemSale('ITEM-0001');
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.ItemSaleView;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ItemSaleView> response = client.items().getItemSale("ITEM-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Items.GetItemSaleAsync("ITEM-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.items.getItemSale('ITEM-0001');
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().GetItemSale(context.Background(), "ITEM-0001", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item": {
"id": 123,
"name": "<string>",
"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
}
}
}
}Returns
{id, name, sale} under item. Here id is an integer, not the item’s id code, so keep using the code in paths.
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.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The item's id, such as ITEM-0001. Not its uuid.
Response
200 - application/json
The short item with its sale section, under item.
Show child attributes
Show child attributes