Discard a draft order

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/orders/ORD-0002/discard_draft" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "note": "Quote no longer needed"
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.orders.createOrderDiscardDraft('ORD-0002', {order: {note: 'Quote no longer needed'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->orders->createOrderDiscardDraft('ORD-0002', [
    'order' => ['note' => 'Quote no longer needed'],
]);
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.OrderDiscardDraft;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderDiscardDraft> response = client.orders().createOrderDiscardDraft(
        "ORD-0002",
        Map.of("order", Map.of("note", "Quote no longer needed")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Orders.CreateOrderDiscardDraftAsync(
    "ORD-0002",
    new Dictionary<string, object?>
    {
        ["order"] = new Dictionary<string, object?>
        {
            ["note"] = "Quote no longer needed",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.orders.createOrderDiscardDraft('ORD-0002', {
  'order': {'note': 'Quote no longer needed'},
});
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().CreateOrderDiscardDraft(context.Background(), "ORD-0002", map[string]any{
	"order": map[string]any{"note": "Quote no longer needed"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "order": {
    "message": "<string>"
  }
}

POST

orders

{order_id}

discard_draft

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/orders/ORD-0002/discard_draft" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "note": "Quote no longer needed"
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.orders.createOrderDiscardDraft('ORD-0002', {order: {note: 'Quote no longer needed'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->orders->createOrderDiscardDraft('ORD-0002', [
    'order' => ['note' => 'Quote no longer needed'],
]);
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.OrderDiscardDraft;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<OrderDiscardDraft> response = client.orders().createOrderDiscardDraft(
        "ORD-0002",
        Map.of("order", Map.of("note", "Quote no longer needed")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Orders.CreateOrderDiscardDraftAsync(
    "ORD-0002",
    new Dictionary<string, object?>
    {
        ["order"] = new Dictionary<string, object?>
        {
            ["note"] = "Quote no longer needed",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.orders.createOrderDiscardDraft('ORD-0002', {
  'order': {'note': 'Quote no longer needed'},
});
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().CreateOrderDiscardDraft(context.Background(), "ORD-0002", map[string]any{
	"order": map[string]any{"note": "Quote no longer needed"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "order": {
    "message": "<string>"
  }
}

Send an optional note under order. The draft is removed: reading the order afterwards returns 404.

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

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

order_id

string

required

The quote's order id. A quote is an order created with quote_order: true.

Body

application/json

order

object

required

Show child attributes

Response

200 - application/json

A confirmation message, under order.message.

order

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response