Get sweep by ID
curl --request GET \
--url http://localhost:3000/v1/sweeps/{id}import requests
url = "http://localhost:3000/v1/sweeps/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/v1/sweeps/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v1/sweeps/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/sweeps/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/sweeps/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"sweep": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retailer_location_id": "<string>",
"sweep_date": "<string>",
"sweep_number": "<string>",
"scheduled_start_time": "<string>",
"scheduled_end_time": "<string>",
"actual_start_time": "<string>",
"actual_end_time": "<string>",
"driver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_items": 123,
"total_load": 123,
"created_at": "<string>",
"updated_at": "<string>",
"retailer_location": {
"id": "<string>",
"taxonomy_id": "<string>",
"name": "<string>",
"retailer_id": "<string>",
"retailer_name": "<string>",
"store_number": "<string>",
"location_route_order": [
"<string>"
],
"address": {
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"province": "<string>",
"postal_code": "<string>",
"country_code": "<string>",
"phone": "<string>"
}
},
"retailer": {
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"brand_logo_url": "<string>"
},
"taxonomy_id": "<string>",
"sweep_type": "<string>",
"is_locked": true,
"delivery_fee": 123,
"picked_items": 123,
"completed_items": 123
},
"items": [
{
"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>"
}
}
],
"order_allocations": [
{
"sweep_item_id": "<string>",
"order_item_id": "<string>",
"allocated_quantity": 123,
"order": {
"id": "<string>",
"order_number": "<string>"
}
}
],
"route_order": [
"<string>"
],
"order_count": 123,
"completed_count": 123,
"pending_count": 123
}{
"error": "Not found"
}Sweeps
Get sweep by ID
Get detailed information about a specific sweep including items and order allocations
GET
/
v1
/
sweeps
/
{id}
Get sweep by ID
curl --request GET \
--url http://localhost:3000/v1/sweeps/{id}import requests
url = "http://localhost:3000/v1/sweeps/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/v1/sweeps/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v1/sweeps/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/sweeps/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/sweeps/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"sweep": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retailer_location_id": "<string>",
"sweep_date": "<string>",
"sweep_number": "<string>",
"scheduled_start_time": "<string>",
"scheduled_end_time": "<string>",
"actual_start_time": "<string>",
"actual_end_time": "<string>",
"driver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_items": 123,
"total_load": 123,
"created_at": "<string>",
"updated_at": "<string>",
"retailer_location": {
"id": "<string>",
"taxonomy_id": "<string>",
"name": "<string>",
"retailer_id": "<string>",
"retailer_name": "<string>",
"store_number": "<string>",
"location_route_order": [
"<string>"
],
"address": {
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"province": "<string>",
"postal_code": "<string>",
"country_code": "<string>",
"phone": "<string>"
}
},
"retailer": {
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"brand_logo_url": "<string>"
},
"taxonomy_id": "<string>",
"sweep_type": "<string>",
"is_locked": true,
"delivery_fee": 123,
"picked_items": 123,
"completed_items": 123
},
"items": [
{
"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>"
}
}
],
"order_allocations": [
{
"sweep_item_id": "<string>",
"order_item_id": "<string>",
"allocated_quantity": 123,
"order": {
"id": "<string>",
"order_number": "<string>"
}
}
],
"route_order": [
"<string>"
],
"order_count": 123,
"completed_count": 123,
"pending_count": 123
}{
"error": "Not found"
}Path Parameters
Sweep UUID or taxonomy ID
⌘I