Skip to main content
PATCH
/
v1
/
sweeps
/
{id}
/
items
/
{itemId}
Update sweep item
curl --request PATCH \
  --url http://localhost:3000/v1/sweeps/{id}/items/{itemId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "picked_quantity": 123,
  "notes": "<string>",
  "actual_price": 123,
  "expected_updated_at": "<string>"
}
'
import requests

url = "http://localhost:3000/v1/sweeps/{id}/items/{itemId}"

payload = {
    "picked_quantity": 123,
    "notes": "<string>",
    "actual_price": 123,
    "expected_updated_at": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    picked_quantity: 123,
    notes: '<string>',
    actual_price: 123,
    expected_updated_at: '<string>'
  })
};

fetch('http://localhost:3000/v1/sweeps/{id}/items/{itemId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v1/sweeps/{id}/items/{itemId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'picked_quantity' => 123,
    'notes' => '<string>',
    'actual_price' => 123,
    'expected_updated_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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 := "http://localhost:3000/v1/sweeps/{id}/items/{itemId}"

	payload := strings.NewReader("{\n  \"picked_quantity\": 123,\n  \"notes\": \"<string>\",\n  \"actual_price\": 123,\n  \"expected_updated_at\": \"<string>\"\n}")

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

	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.patch("http://localhost:3000/v1/sweeps/{id}/items/{itemId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"picked_quantity\": 123,\n  \"notes\": \"<string>\",\n  \"actual_price\": 123,\n  \"expected_updated_at\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/sweeps/{id}/items/{itemId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"picked_quantity\": 123,\n  \"notes\": \"<string>\",\n  \"actual_price\": 123,\n  \"expected_updated_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "item": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "retailer_mapping_id": "<string>",
    "store_item_id": "<string>",
    "quantity": 123,
    "picked_quantity": 123,
    "notes": "<string>",
    "store_location_text": "<string>",
    "store_aisle": 123,
    "unit_price": 123,
    "actual_price": 123,
    "is_for_inventory": true,
    "product": {
      "id": "<string>",
      "sellable_product_id": "<string>",
      "taxonomy_id": "<string>",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "barcode": "<string>",
      "scan_barcode": "<string>",
      "norm_barcode": "<string>",
      "size": "<string>",
      "product_page_url": "<string>"
    },
    "scraped_product": {
      "id": "<string>",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "barcode": "<string>"
    }
  }
}
{
  "error": "Not found"
}
{
  "error": "<string>",
  "conflict": true,
  "item": null
}
{
  "error": "Not found"
}

Path Parameters

id
string
required

Sweep UUID or taxonomy ID

itemId
string<uuid>
required

Sweep item UUID

Body

application/json
picked_quantity
number
status
enum<string>
Available options:
pending,
picked,
unavailable,
substituted
notes
string
actual_price
number
partial_reason
enum<string>
Available options:
out_of_stock,
cant_locate
expected_updated_at
string

Response

Item updated successfully

success
boolean
required
item
object
required