Compound orderBy. Order the data by a given field. Comma-separated string. Can not be used in conjunction as standard orderBy.
Filter the request on a single field. Key-Value or Key-Operator-Value comma-separated string.
-Compound where. Use when you need to filter on multiple where's. Note only AND is possible; ORWHERE is not available.
curl --request GET \
- --get "http://vine.test/api/v1/my-teams?cached=1&page=1&limit=50&fields=id%2Ccreated_at&orderBy=orderBy%3Did%2Cdesc&orderBy%5B%5D=orderBy%5B%5D%3Did%2Cdesc%26orderBy%5B%5D%3Dcreated_at%2Casc&where=where%3Did%2Clike%2C%2A550e%2A&where%5B%5D=where%5B%5D%3Did%2Clike%2C%2A550e%2A%26where%5B%5D%3Dcreated_at%2C%3E%3D%2C2024-01-01" \
- --header "Authorization: Bearer {YOUR_API_TOKEN}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"{
- "meta": {
- "responseCode": 200,
- "limit": 50,
- "offset": 0,
- "message": "",
- "cached": false,
- "availableRelations": []
- },
- "data": {
- "current_page": 1,
- "data": [
- {
- "id": 1,
- "name": "Team A",
- "created_at": "2024-08-16T06:54:28.000000Z",
- "updated_at": "2024-08-16T06:54:28.000000Z",
- "deleted_at": null
- },
- {
- "id": 2,
- "name": "Team B",
- "created_at": "2024-08-16T06:54:29.000000Z",
- "updated_at": "2024-08-16T06:54:29.000000Z",
- "deleted_at": null
- }
- ],
- "first_page_url": "https://vine.test/api/v1/my-teams?page=1",
- "from": 1,
- "last_page": 1,
- "last_page_url": "https://vine.test/api/v1/my-teams?page=1",
- "links": [
- {
- "url": null,
- "label": "« Previous",
- "active": false
- },
- {
- "url": "https://vine.test/api/v1/my-teams?page=1",
- "label": "1",
- "active": true
- },
- {
- "url": null,
- "label": "Next »",
- "active": false
- }
- ],
- "next_page_url": null,
- "path": "https://vine.test/api/v1/my-teams",
- "per_page": 50,
- "prev_page_url": null,
- "to": 2,
- "total": 2
- }
-}API for managing shops
- -Create a new shop.
-curl --request POST \
- "http://vine.test/api/v1/shops" \
- --header "Authorization: Bearer {YOUR_API_TOKEN}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" \
- --data "{
- \"shop_name\": \"qui\",
- \"user_email\": \"ppfeffer@example.net\",
- \"user_name\": \"tenetur\"
-}"
-{"meta":{"responseCode":200,"limit":50,"offset":0,"message":"Saved. Here is the API Token for the user linked to this new team. It will only be displayed ONCE, so please store it in a secure manner.","cached":false,"availableRelations":[]},"data":"{TOKEN}"curl --request GET \
- --get "http://vine.test/api/v1/shops" \
- --header "Authorization: Bearer {YOUR_API_TOKEN}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" cache-control
- : no-cache, private
- content-type
- : application/json
- access-control-allow-origin
- : *
- {
- "message": "Unauthenticated."
-}Get shop with ID {id}
-The ID of the shop.
-curl --request GET \
- --get "http://vine.test/api/v1/shops/esse" \
- --header "Authorization: Bearer {YOUR_API_TOKEN}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" cache-control
- : no-cache, private
- content-type
- : application/json
- access-control-allow-origin
- : *
- {
- "message": "Unauthenticated."
-}Update shop with ID {id}.
-Compound orderBy. Order the data by a given field. Comma-separated string. Can not be used in conjunction as standard orderBy.
Filter the request on a single field. Key-Value or Key-Operator-Value comma-separated string.
+The ID of the shop.
+Compound where. Use when you need to filter on multiple where's. Note only AND is possible; ORWHERE is not available.
curl --request PUT \
- "http://vine.test/api/v1/shops/est" \
+ curl --request GET \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/my-teams?cached=1&page=1&limit=50&fields=id%2Ccreated_at&orderBy=orderBy%3Did%2Cdesc&orderBy%5B%5D=orderBy%5B%5D%3Did%2Cdesc%26orderBy%5B%5D%3Dcreated_at%2Casc&where=where%3Did%2Clike%2C%2A550e%2A&where%5B%5D=where%5B%5D%3Did%2Clike%2C%2A550e%2A%26where%5B%5D%3Dcreated_at%2C%3E%3D%2C2024-01-01" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
const url = new URL(
- "http://vine.test/api/v1/shops/est"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-teams"
);
+const params = {
+ "cached": "1",
+ "page": "1",
+ "limit": "50",
+ "fields": "id,created_at",
+ "orderBy": "orderBy=id,desc",
+ "orderBy[]": "orderBy[]=id,desc&orderBy[]=created_at,asc",
+ "where": "where=id,like,*550e*",
+ "where[]": "where[]=id,like,*550e*&where[]=created_at,>=,2024-01-01",
+};
+Object.keys(params)
+ .forEach(key => url.searchParams.append(key, params[key]));
+
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
@@ -3034,7 +1705,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/shops/est';
-$response = $client->put(
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-teams';
+$response = $client->get(
$url,
[
'headers' => [
@@ -3053,6 +1724,16 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/shops/est'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-teams'
+params = {
+ 'cached': '1',
+ 'page': '1',
+ 'limit': '50',
+ 'fields': 'id,created_at',
+ 'orderBy': 'orderBy=id,desc',
+ 'orderBy[]': 'orderBy[]=id,desc&orderBy[]=created_at,asc',
+ 'where': 'where=id,like,*550e*',
+ 'where[]': 'where[]=id,like,*550e*&where[]=created_at,>=,2024-01-01',
+}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
-response = requests.request('PUT', url, headers=headers)
+response = requests.request('GET', url, headers=headers, params=params)
response.json()nullAPI for managing shops
+ +DELETE shop with ID {id}.
+Create a new shop.
curl --request DELETE \
- "http://vine.test/api/v1/shops/in" \
+ curl --request POST \
+ "https://vine.openfoodnetwork.org.au/api/v1/shops" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
- --header "Accept: application/json"
const url = new URL(
- "http://vine.test/api/v1/shops/in"
+ "https://vine.openfoodnetwork.org.au/api/v1/shops"
);
const headers = {
@@ -3304,9 +2115,16 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/shops/in';
-$response = $client->delete(
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/shops';
+$response = $client->post(
$url,
[
'headers' => [
@@ -3324,6 +2142,11 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/shops/in'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/shops'
+payload = {
+ "shop_name": "velit",
+ "user_email": "anahi30@example.net",
+ "user_name": "vel"
+}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
-response = requests.request('DELETE', url, headers=headers)
+response = requests.request('POST', url, headers=headers, json=payload)
response.json()nullcurl --request GET \
- --get "http://vine.test/api/v1/system-statistics?cached=1&page=1&limit=50&fields=id%2Csum_voucher_value_total&orderBy=orderBy%3Dsum_voucher_value_total%2Cdesc&orderBy%5B%5D=orderBy%5B%5D%3Did%2Cdesc%26orderBy%5B%5D%3Dcreated_at%2Casc&where=where%3Did%2C%3E%2C123&where%5B%5D=where%5B%5D%3Did%2Clike%2C%2A550e%2A%26where%5B%5D%3Dcreated_at%2C%3E%3D%2C2024-01-01" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/system-statistics?cached=1&page=1&limit=50&fields=id%2Csum_voucher_value_total&orderBy=orderBy%3Dsum_voucher_value_total%2Cdesc&orderBy%5B%5D=orderBy%5B%5D%3Did%2Cdesc%26orderBy%5B%5D%3Dcreated_at%2Casc&where=where%3Did%2C%3E%2C123&where%5B%5D=where%5B%5D%3Did%2Clike%2C%2A550e%2A%26where%5B%5D%3Dcreated_at%2C%3E%3D%2C2024-01-01" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/system-statistics"
+ "https://vine.openfoodnetwork.org.au/api/v1/system-statistics"
);
const params = {
@@ -3759,7 +2587,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/system-statistics';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/system-statistics';
$response = $client->get(
$url,
[
@@ -3791,7 +2619,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/system-statistics'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/system-statistics'
params = {
'cached': '1',
'page': '1',
@@ -3912,7 +2740,7 @@ class="language-json sl-overflow-x-auto sl-overflow-y-auto">{
curl --request GET \
- --get "http://vine.test/api/v1/system-statistics/4?cached=1&fields=id%2Cnum_users" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/system-statistics/19?cached=1&fields=id%2Cnum_users" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/system-statistics/4"
+ "https://vine.openfoodnetwork.org.au/api/v1/system-statistics/19"
);
const params = {
@@ -4152,7 +2980,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/system-statistics/4';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/system-statistics/19';
$response = $client->get(
$url,
[
@@ -4178,7 +3006,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/system-statistics/4'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/system-statistics/19'
params = {
'cached': '1',
'fields': 'id,num_users',
@@ -4279,7 +3107,7 @@ class="sl-text-5xl sl-leading-tight sl-font-prose sl-text-heading"
curl --request GET \
- --get "http://vine.test/api/v1/my-team" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/my-team" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team"
);
const headers = {
@@ -4432,7 +3260,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team';
$response = $client->get(
$url,
[
@@ -4454,7 +3282,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -4546,7 +3374,7 @@ class="language-json sl-overflow-x-auto sl-overflow-y-auto">{
curl --request POST \
- "http://vine.test/api/v1/my-team" \
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team"
);
const headers = {
@@ -4699,7 +3527,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team';
$response = $client->post(
$url,
[
@@ -4721,7 +3549,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -4750,7 +3578,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testcurl --request GET \
- --get "http://vine.test/api/v1/my-team/ullam" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/my-team/sit" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team/ullam"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team/sit"
);
const headers = {
@@ -4933,7 +3761,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team/ullam';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/sit';
$response = $client->get(
$url,
[
@@ -4955,7 +3783,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team/ullam'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/sit'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -5047,7 +3875,7 @@ class="language-json sl-overflow-x-auto sl-overflow-y-auto">{
curl --request PUT \
- "http://vine.test/api/v1/my-team/blanditiis" \
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team/qui" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team/blanditiis"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team/qui"
);
const headers = {
@@ -5235,7 +4063,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team/blanditiis';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/qui';
$response = $client->put(
$url,
[
@@ -5257,7 +4085,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team/blanditiis'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/qui'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -5286,7 +4114,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testcurl --request DELETE \
- "http://vine.test/api/v1/my-team/sunt" \
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team/sint" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team/sunt"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team/sint"
);
const headers = {
@@ -5469,7 +4297,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team/sunt';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/sint';
$response = $client->delete(
$url,
[
@@ -5491,7 +4319,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team/sunt'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team/sint'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -5520,7 +4348,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testcurl --request POST \
- "http://vine.test/api/v1/my-team-audit-items" \
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team-audit-items"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items"
);
const headers = {
@@ -5673,7 +4501,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team-audit-items';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items';
$response = $client->post(
$url,
[
@@ -5695,7 +4523,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team-audit-items'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -5724,7 +4552,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testcurl --request GET \
- --get "http://vine.test/api/v1/my-team-audit-items" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team-audit-items"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items"
);
const headers = {
@@ -5877,7 +4705,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team-audit-items';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items';
$response = $client->get(
$url,
[
@@ -5899,7 +4727,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team-audit-items'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -5991,7 +4819,7 @@ class="language-json sl-overflow-x-auto sl-overflow-y-auto">{
curl --request GET \
- --get "http://vine.test/api/v1/my-team-audit-items/voluptatem" \
+ --get "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/fuga" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team-audit-items/voluptatem"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/fuga"
);
const headers = {
@@ -6174,7 +5002,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team-audit-items/voluptatem';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/fuga';
$response = $client->get(
$url,
[
@@ -6196,7 +5024,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team-audit-items/voluptatem'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/fuga'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
@@ -6288,7 +5116,7 @@ class="language-json sl-overflow-x-auto sl-overflow-y-auto">{
curl --request DELETE \
- "http://vine.test/api/v1/my-team-audit-items/unde" \
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/vel" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
- "http://vine.test/api/v1/my-team-audit-items/unde"
+ "https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/vel"
);
const headers = {
@@ -6471,7 +5299,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.test$client = new \GuzzleHttp\Client();
-$url = 'http://vine.test/api/v1/my-team-audit-items/unde';
+$url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/vel';
$response = $client->delete(
$url,
[
@@ -6493,7 +5321,7 @@ class="sl-overflow-x-hidden sl-truncate sl-text-muted">http://vine.testimport requests
import json
-url = 'http://vine.test/api/v1/my-team-audit-items/unde'
+url = 'https://vine.openfoodnetwork.org.au/api/v1/my-team-audit-items/vel'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',