Update an item fulfillment

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/item_fulfillments/ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "item_fulfillment": {
      "tracking_number": "TRK-0001"
    }
  }'

from exsited import build_client

client = build_client()

response = client.item_fulfillments.update_item_fulfillment(
    "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
    {"item_fulfillment": {"tracking_number": "TRK-0001"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemFulfillments.updateItemFulfillment('ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9', {
    item_fulfillment: {tracking_number: 'TRK-0001'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->itemFulfillments->updateItemFulfillment(
    'ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9',
    ['item_fulfillment' => ['tracking_number' => 'TRK-0001']],
);
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.ItemFulfillmentUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemFulfillmentUpdated> response = client.itemFulfillments().updateItemFulfillment(
        "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
        Map.of("item_fulfillment", Map.of("tracking_number", "TRK-0001")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemFulfillments.UpdateItemFulfillmentAsync(
    "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
    new Dictionary<string, object?>
    {
        ["item_fulfillment"] = new Dictionary<string, object?>
        {
            ["tracking_number"] = "TRK-0001",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.itemFulfillments.updateItemFulfillment(
  'ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9',
  {
    'item_fulfillment': {'tracking_number': 'TRK-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.ItemFulfillments().UpdateItemFulfillment(context.Background(), "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9", map[string]any{
	"item_fulfillment": map[string]any{"tracking_number": "TRK-0001"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "item_fulfillment": {
    "code": "<string>",
    "href": "<string>",
    "id": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": 123
  }
}

PATCH

item_fulfillments

{fulfillment_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/item_fulfillments/ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "item_fulfillment": {
      "tracking_number": "TRK-0001"
    }
  }'

from exsited import build_client

client = build_client()

response = client.item_fulfillments.update_item_fulfillment(
    "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
    {"item_fulfillment": {"tracking_number": "TRK-0001"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemFulfillments.updateItemFulfillment('ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9', {
    item_fulfillment: {tracking_number: 'TRK-0001'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->itemFulfillments->updateItemFulfillment(
    'ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9',
    ['item_fulfillment' => ['tracking_number' => 'TRK-0001']],
);
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.ItemFulfillmentUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemFulfillmentUpdated> response = client.itemFulfillments().updateItemFulfillment(
        "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
        Map.of("item_fulfillment", Map.of("tracking_number", "TRK-0001")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemFulfillments.UpdateItemFulfillmentAsync(
    "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9",
    new Dictionary<string, object?>
    {
        ["item_fulfillment"] = new Dictionary<string, object?>
        {
            ["tracking_number"] = "TRK-0001",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.itemFulfillments.updateItemFulfillment(
  'ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9',
  {
    'item_fulfillment': {'tracking_number': 'TRK-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.ItemFulfillments().UpdateItemFulfillment(context.Background(), "ifm_9a8b7c6d5e4f30211203f4e5d6c7b8a9", map[string]any{
	"item_fulfillment": map[string]any{"tracking_number": "TRK-0001"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "item_fulfillment": {
    "code": "<string>",
    "href": "<string>",
    "id": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": 123
  }
}

Send the changes under item_fulfillment, such as a new tracking_number. The response gives the fulfillment’s id, code, status and new version under item_fulfillment.

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

fulfillment_id

string

required

The fulfillment's id, which starts with ifm_.

Body

application/json

item_fulfillment

object

required

Show child attributes

Response

200 - application/json

The short fulfillment record, under item_fulfillment.

item_fulfillment

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response