Update an item receipt

cURL

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

from exsited import build_client

client = build_client()

response = client.item_receipts.update_item_receipt(
    "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
    {"item_receipt": {"tracking_number": "TRK-0001"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemReceipts.updateItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d', {
    item_receipt: {tracking_number: 'TRK-0001'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->itemReceipts->updateItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d', [
    'item_receipt' => ['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_receipts.item_receipts_dto.ItemReceiptsDto.ItemReceiptUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemReceiptUpdated> response = client.itemReceipts().updateItemReceipt(
        "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
        Map.of("item_receipt", Map.of("tracking_number", "TRK-0001")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemReceipts.UpdateItemReceiptAsync(
    "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
    new Dictionary<string, object?>
    {
        ["item_receipt"] = new Dictionary<string, object?>
        {
            ["tracking_number"] = "TRK-0001",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.itemReceipts.updateItemReceipt(
  'ir_4e5f60718293a4b5c6d7e8f90a1b2c3d',
  {
    'item_receipt': {'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.ItemReceipts().UpdateItemReceipt(context.Background(), "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d", map[string]any{
	"item_receipt": map[string]any{"tracking_number": "TRK-0001"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "item_receipt": {
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "item": {
          "code": "<string>",
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>"
        },
        "pending_return_quantity": 123,
        "purchase_order_line": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "receipt_quantity": 123,
        "received_quantity": 123,
        "returned_quantity": 123,
        "uom": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "warehouse": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        }
      }
    ],
    "object": "<string>",
    "purchase_order": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "receipt_date": "<string>",
    "receipt_note": "<string>",
    "receipt_status": "<string>",
    "receive_completed": true,
    "status": "<string>",
    "tracking_number": "<string>",
    "version": 123
  }
}

PATCH

item_receipts

{item_receipt_id}

cURL

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

from exsited import build_client

client = build_client()

response = client.item_receipts.update_item_receipt(
    "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
    {"item_receipt": {"tracking_number": "TRK-0001"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.itemReceipts.updateItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d', {
    item_receipt: {tracking_number: 'TRK-0001'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->itemReceipts->updateItemReceipt('ir_4e5f60718293a4b5c6d7e8f90a1b2c3d', [
    'item_receipt' => ['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_receipts.item_receipts_dto.ItemReceiptsDto.ItemReceiptUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ItemReceiptUpdated> response = client.itemReceipts().updateItemReceipt(
        "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
        Map.of("item_receipt", Map.of("tracking_number", "TRK-0001")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ItemReceipts.UpdateItemReceiptAsync(
    "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d",
    new Dictionary<string, object?>
    {
        ["item_receipt"] = new Dictionary<string, object?>
        {
            ["tracking_number"] = "TRK-0001",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.itemReceipts.updateItemReceipt(
  'ir_4e5f60718293a4b5c6d7e8f90a1b2c3d',
  {
    'item_receipt': {'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.ItemReceipts().UpdateItemReceipt(context.Background(), "ir_4e5f60718293a4b5c6d7e8f90a1b2c3d", map[string]any{
	"item_receipt": map[string]any{"tracking_number": "TRK-0001"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "item_receipt": {
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "lines": [
      {
        "item": {
          "code": "<string>",
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>"
        },
        "pending_return_quantity": 123,
        "purchase_order_line": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "receipt_quantity": 123,
        "received_quantity": 123,
        "returned_quantity": 123,
        "uom": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "warehouse": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        }
      }
    ],
    "object": "<string>",
    "purchase_order": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "receipt_date": "<string>",
    "receipt_note": "<string>",
    "receipt_status": "<string>",
    "receive_completed": true,
    "status": "<string>",
    "tracking_number": "<string>",
    "version": 123
  }
}

Send the changes under item_receipt, such as a new tracking_number, receipt_note or receipt_date. The receipt comes back under item_receipt with a higher version.

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

item_receipt_id

string

required

The receipt's id, which starts with ir_.

Body

application/json

item_receipt

object

required

Show child attributes

Response

200 - application/json

The updated receipt, under item_receipt.

item_receipt

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response