cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/information" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.orders.get_order_information("ORD-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.getOrderInformation('ORD-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->getOrderInformation('ORD-0001');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderInformation;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<OrderInformation> response = client.orders().getOrderInformation("ORD-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.GetOrderInformationAsync("ORD-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.getOrderInformation('ORD-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.Orders().GetOrderInformation(context.Background(), "ORD-0001", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"order": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"allow_contract": true,
"billing_address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"address_line_4": "<string>",
"address_line_5": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"billing_start_date": "<string>",
"billing_start_day_of_month": "<string>",
"communication_preferences": [
{
"channel": "<string>",
"enabled": true
}
],
"created_by": "<unknown>",
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"customer_purchase_order_id": "<unknown>",
"description": "<string>",
"discount_profile": {
"amount": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"redemption_code": "<string>",
"type": "<string>"
},
"display_name": "<string>",
"id": "<string>",
"invoice_note": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"manager": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"name": "<string>",
"next_billing_from_date": "<string>",
"next_billing_from_date_utc": "<string>",
"object": "<string>",
"order_start_date": "<string>",
"order_type": "<string>",
"origin": "<string>",
"original_total": "<string>",
"pre_order": true,
"price_tax_inclusive": true,
"quote_converted": true,
"quote_order": true,
"referral_account": "<unknown>",
"sales_rep": "<unknown>",
"shipping_address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"address_line_4": "<string>",
"address_line_5": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"shipping_cost": 123,
"shipping_profile": "<unknown>",
"status": "<string>",
"time_zone": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"version": 123
}
}Orders
Retrieve an order's information
Returns an order’s header information without its lines, under order.
GET
/
orders
/
{order_id}
/
information
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/information" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.orders.get_order_information("ORD-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.getOrderInformation('ORD-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->getOrderInformation('ORD-0001');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderInformation;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<OrderInformation> response = client.orders().getOrderInformation("ORD-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.GetOrderInformationAsync("ORD-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.getOrderInformation('ORD-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.Orders().GetOrderInformation(context.Background(), "ORD-0001", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"order": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"allow_contract": true,
"billing_address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"address_line_4": "<string>",
"address_line_5": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"billing_start_date": "<string>",
"billing_start_day_of_month": "<string>",
"communication_preferences": [
{
"channel": "<string>",
"enabled": true
}
],
"created_by": "<unknown>",
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"customer_purchase_order_id": "<unknown>",
"description": "<string>",
"discount_profile": {
"amount": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"redemption_code": "<string>",
"type": "<string>"
},
"display_name": "<string>",
"id": "<string>",
"invoice_note": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"manager": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"name": "<string>",
"next_billing_from_date": "<string>",
"next_billing_from_date_utc": "<string>",
"object": "<string>",
"order_start_date": "<string>",
"order_type": "<string>",
"origin": "<string>",
"original_total": "<string>",
"pre_order": true,
"price_tax_inclusive": true,
"quote_converted": true,
"quote_order": true,
"referral_account": "<unknown>",
"sales_rep": "<unknown>",
"shipping_address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"address_line_4": "<string>",
"address_line_5": "<string>",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"shipping_cost": 123,
"shipping_profile": "<unknown>",
"status": "<string>",
"time_zone": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"version": 123
}
}Pass the order’s
id. The response holds fields such as name, description, currency, the addresses and the dates, but no lines or totals.
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 order's id, as GET /orders lists it.
Response
200 - application/json
The order's information, under order.
Show child attributes
Show child attributes