Resolve a receipt recorded without stock

curl --request POST \
  --url https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2
}
'

import requests

url = "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock"

payload = {
    "note": "<string>",
    "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: '<string>', note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', quantity: 2})
};

fetch('https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'note' => '<string>',
    'note_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock"

	payload := strings.NewReader("{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "repair_stock": {
      "mode": "book_missing_stock",
      "quantity": 123,
      "stage_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rollup": [
        {}
      ],
      "inventory_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "holding_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lineage": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "fifo_layer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "inventory_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "origin": "<string>"
        }
      ],
      "unit_cost_basis": "<string>",
      "order_line": {
        "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lowered": 123,
        "clamped": 123
      }
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "return",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_number": "<string>",
    "status": "authorized",
    "original_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_location_source": "order",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_rma_number": "<string>",
    "inspection_required": true,
    "restocking_fee": 123,
    "restocking_bound": {
      "code": "restocking_fee_above_entity_max",
      "entity_fee_min": 123,
      "entity_fee_max": 123,
      "outcome": "clamped",
      "from": 123,
      "to": 123,
      "source": "stamp",
      "words": "<string>"
    },
    "refund_amount": 123,
    "return_to_vendor": true,
    "refund_hold": true,
    "refund_hold_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "refund_hold_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "refund_hold_at": "2023-11-07T05:31:56Z",
    "is_pre_settlement": true,
    "estimated_refund_amount": 123,
    "estimated_refund_tax": 123,
    "money_suppression": {
      "basis": "decision",
      "whole_no_money": true,
      "unreadable": true,
      "waived_goods": 123,
      "waived_tax": 123,
      "legacy_swap": {}
    },
    "source": "csr",
    "notes": "<string>",
    "metadata": {},
    "received_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "return_label_refund_status": "pending",
    "return_label_void_requested_at": "2023-11-07T05:31:56Z",
    "return_label_voided_at": "2023-11-07T05:31:56Z",
    "return_label_refunded_at": "2023-11-07T05:31:56Z",
    "return_label_refund_detail": "<string>",
    "return_label_freight_je_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_label_freight_owed_at": "2023-11-07T05:31:56Z",
    "return_label_freight_error": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "message": "<string>",
  "permission_key": "<string>",
  "role": "<string>"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

Returns

Resolve a receipt recorded without stock

Resolves a receipt item that was recorded as received without its stock entering, the state a refusal receipt_recorded_without_stock names. A person chooses one of two ways; nothing happens on its own. book_missing_stock: a physical count found the units, so they are booked into the Holding location now, every unit of the item at once, at the cost the receipt item carries, else the cost the receive would book them at, else an entered_cost with a reason (422 receipt_cost_required asks for one). reverse_unbacked: the units never came, so the item’s received count is lowered with no stock movement; a return that settled money is refused until its settlement is re-opened (409 return_money_settled). note (or note_id) says why and is kept as a note on the return; the act is written on its activity under the key’s creator. Requires the returns:write scope and, for the key’s creator, inventory.adjust to book the stock or returns.unreceive to reverse the count.

POST

returns

{id}

receipt-items

{receipt_item_id}

repair-stock

Resolve a receipt recorded without stock

curl --request POST \
  --url https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 2
}
'

import requests

url = "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock"

payload = {
    "note": "<string>",
    "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: '<string>', note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', quantity: 2})
};

fetch('https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'note' => '<string>',
    'note_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quantity' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock"

	payload := strings.NewReader("{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/returns/{id}/receipt-items/{receipt_item_id}/repair-stock")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"note\": \"<string>\",\n  \"note_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quantity\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "repair_stock": {
      "mode": "book_missing_stock",
      "quantity": 123,
      "stage_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rollup": [
        {}
      ],
      "inventory_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "holding_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lineage": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "fifo_layer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "inventory_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "origin": "<string>"
        }
      ],
      "unit_cost_basis": "<string>",
      "order_line": {
        "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lowered": 123,
        "clamped": 123
      }
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "return",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_number": "<string>",
    "status": "authorized",
    "original_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_location_source": "order",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_rma_number": "<string>",
    "inspection_required": true,
    "restocking_fee": 123,
    "restocking_bound": {
      "code": "restocking_fee_above_entity_max",
      "entity_fee_min": 123,
      "entity_fee_max": 123,
      "outcome": "clamped",
      "from": 123,
      "to": 123,
      "source": "stamp",
      "words": "<string>"
    },
    "refund_amount": 123,
    "return_to_vendor": true,
    "refund_hold": true,
    "refund_hold_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "refund_hold_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "refund_hold_at": "2023-11-07T05:31:56Z",
    "is_pre_settlement": true,
    "estimated_refund_amount": 123,
    "estimated_refund_tax": 123,
    "money_suppression": {
      "basis": "decision",
      "whole_no_money": true,
      "unreadable": true,
      "waived_goods": 123,
      "waived_tax": 123,
      "legacy_swap": {}
    },
    "source": "csr",
    "notes": "<string>",
    "metadata": {},
    "received_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "return_label_refund_status": "pending",
    "return_label_void_requested_at": "2023-11-07T05:31:56Z",
    "return_label_voided_at": "2023-11-07T05:31:56Z",
    "return_label_refunded_at": "2023-11-07T05:31:56Z",
    "return_label_refund_detail": "<string>",
    "return_label_freight_je_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "return_label_freight_owed_at": "2023-11-07T05:31:56Z",
    "return_label_freight_error": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "message": "<string>",
  "permission_key": "<string>",
  "role": "<string>"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "door": "<string>",
  "return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {}
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Headers

Idempotency-Key

string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. A second request with the same key sent while the first is still running waits for it and returns its answer; if the first is still running after 20 seconds the second answers 409 idempotency_key_in_use (retryable, nothing done). An answer carrying retryable: true is not cached. Reusing a key with a different request body answers 409 idempotency_key_collision (nothing done; send the new request with a fresh key). The replay, the wait and these two 409 codes come from the idempotency layer, so they apply to the operations that run it, each of which can answer the two codes whether or not its own 409 response lists them. The handlers of these operations take the header but do not run the layer, so on them the key neither replays nor answers either code: createPaymentPlan, chargePaymentPlanInstallment, setProductLocations, updateOrder, emailOrder, updateOrderItem, confirmPickup, markOrderNoShow, applyExistingPaymentToInvoices, updatePackage, movePackageItem, changePackageBox, changePackageCarrier, voidPackageLabel, printPackageLabel, emailPackage, setProNumberV1, setPackageProNumber, sendPurchaseOrderToVendorV1, notifyRevisionPurchaseOrderV1, addMaintenanceLog, generateBOLV1, createReportJobV1 and customerAcknowledgeRevision; recordVendorPrepaymentV1 and recordCustomerDepositV1 hand the key to their own write instead.

Maximum string length: 255

Path Parameters

string<uuid>

required

receipt_item_id

string<uuid>

required

A receipt item of the return recorded as received without stock entering (its stock_mode is stock_missing).

Body

application/json

mode

enum<string>

required

How the item is resolved. Any other value is refused 422 repair_mode_invalid.

Available options:

book_missing_stock,

reverse_unbacked

note

string

The physical count that found the units (book_missing_stock), or why the count is reversed, in 10 characters or more (else 422 count_note_required). Required unless note_id is sent.

Minimum string length: 10

note_id

string<uuid>

A note of this entity that already says it, instead of note (one that is not this entity's is refused 422 note_not_found).

quantity

integer

The units to resolve, 1 up to the item's units still waiting (default all of them). Booking the stock books all of them; any other number is refused 422 quantity_invalid.

Required range: x >= 1

entered_cost

object

On book_missing_stock, the unit cost the units are booked at when neither the receipt item nor the sale carries one (422 receipt_cost_required names it); a line whose cost is known from the sale refuses it.

Show child attributes

Response

Resolved. The return as GET /returns/{id} answers it, with what this act did as repair_stock.

data

object

required

RMA (return merchandise authorization). Phase A -- refund_amount is readOnly via PATCH; written only by POST /v1/returns/{id}/refund.

Show child attributes

Overview

All Endpoints

Resolve a receipt recorded without stock

Authorizations

Headers

Path Parameters

Body

Response