{ "item": [ { "id": "c6222506-89c6-4afd-9d20-93a865799369", "name": "Users", "description": { "content": "Fake people. Your own, plus the read only sample users.", "type": "text/plain" }, "item": [ { "id": "d8aaa0ba-2a35-4239-8304-bd975247641c", "name": "List users", "request": { "name": "List users", "description": {}, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[status]", "value": "", "description": "`filter[status]=active,inactive` (any of), `filter[email]=` (exact, lower case)." }, { "disabled": true, "key": "filter[email]", "value": "", "description": "`filter[status]=active,inactive` (any of), `filter[email]=` (exact, lower case)." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[users]", "value": "", "description": "`fields[users]=id,name` returns only those fields." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4f0bf74-524d-45fa-a18b-bb11ed48edea", "name": "Create a user", "request": { "name": "Create a user", "description": {}, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdab7821-1670-47f4-b414-e3cf062e3242", "name": "Get a user", "request": { "name": "Get a user", "description": {}, "url": { "path": [ "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[users]", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8d5b8e1-7b25-47ef-af0f-b0fdb5bfc971", "name": "Change a user (JSON Merge Patch)", "request": { "name": "Change a user (JSON Merge Patch)", "description": {}, "url": { "path": [ "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "015cda00-aafa-4387-b5bf-f280e0dfd3dd", "name": "Delete a user", "request": { "name": "Delete a user", "description": {}, "url": { "path": [ "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c07bf70b-b3da-4005-9002-6445c66f3735", "name": "Posts", "description": { "content": "Posts by your users or the sample users, with their comments.", "type": "text/plain" }, "item": [ { "id": "de04b893-710d-4361-ad61-701546a8a5da", "name": "List posts", "request": { "name": "List posts", "description": {}, "url": { "path": [ "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[user_id]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=draft,published` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[status]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=draft,published` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[posts]", "value": "", "description": "`fields[posts]=id,title` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `comments`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1be996f0-f370-4c33-b123-542c4ff39c28", "name": "Create a post", "request": { "name": "Create a post", "description": {}, "url": { "path": [ "posts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\",\n \"title\": \"\",\n \"body\": \"\",\n \"status\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3c06362-84da-4c32-a4b2-8a102aaedb5d", "name": "Get a post", "request": { "name": "Get a post", "description": {}, "url": { "path": [ "posts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[posts]", "value": "", "description": "`fields[posts]=id,title` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `comments`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea379fe0-6484-4aae-a53d-eab363c11fbf", "name": "Change a post (JSON Merge Patch)", "request": { "name": "Change a post (JSON Merge Patch)", "description": {}, "url": { "path": [ "posts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\",\n \"title\": \"\",\n \"body\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3951c537-f226-4c03-9cd3-befd98174492", "name": "Delete a post", "request": { "name": "Delete a post", "description": {}, "url": { "path": [ "posts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c2ef4c11-61ca-4cb2-9835-d3af1a1dc328", "name": "Comments", "description": { "content": "Comments on posts you can see.", "type": "text/plain" }, "item": [ { "id": "8157ae58-4d62-478d-a4c6-12b1a9095ff8", "name": "List comments", "request": { "name": "List comments", "description": {}, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[post_id]", "value": "", "description": "`filter[post_id]=`, `filter[user_id]=` (one id each). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[user_id]", "value": "", "description": "`filter[post_id]=`, `filter[user_id]=` (one id each). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[comments]", "value": "", "description": "`fields[comments]=id,body` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `post`, `user`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfc4cb9b-97de-4eed-83f1-f98b7d58376b", "name": "Create a comment", "request": { "name": "Create a comment", "description": {}, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"post_id\": \"\",\n \"user_id\": \"\",\n \"body\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80425ea3-ff76-41e7-a795-bd8da77f2e3d", "name": "Get a comment", "request": { "name": "Get a comment", "description": {}, "url": { "path": [ "comments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[comments]", "value": "", "description": "`fields[comments]=id,body` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `post`, `user`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c9379c6-cabe-4628-bfe2-b9a5ba3485c8", "name": "Change a comment (JSON Merge Patch)", "request": { "name": "Change a comment (JSON Merge Patch)", "description": {}, "url": { "path": [ "comments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"body\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb57cbd3-a5b3-4967-8db4-ee13ef064a29", "name": "Delete a comment", "request": { "name": "Delete a comment", "description": {}, "url": { "path": [ "comments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f81d823c-c99f-4b73-b172-1244b41d342a", "name": "Tasks", "description": { "content": "To do items, each optionally given to a user.", "type": "text/plain" }, "item": [ { "id": "8c3f32ee-3b7f-4c22-a57a-28cdabac7d0e", "name": "List tasks", "request": { "name": "List tasks", "description": {}, "url": { "path": [ "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[user_id]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=todo,in_progress,done` and `filter[priority]=low,medium,high,urgent` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[status]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=todo,in_progress,done` and `filter[priority]=low,medium,high,urgent` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[priority]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=todo,in_progress,done` and `filter[priority]=low,medium,high,urgent` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[tasks]", "value": "", "description": "`fields[tasks]=id,title` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "934d08f2-2a8b-4871-ab58-b80398389f72", "name": "Create a task", "request": { "name": "Create a task", "description": {}, "url": { "path": [ "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"user_id\": \"\",\n \"description\": \"\",\n \"status\": \"todo\",\n \"priority\": \"medium\",\n \"due_on\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "619b7a41-d7a4-464e-881a-13ea319f6091", "name": "Get a task", "request": { "name": "Get a task", "description": {}, "url": { "path": [ "tasks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[tasks]", "value": "", "description": "`fields[tasks]=id,title` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "582ee181-e430-4806-832c-d2119f781e33", "name": "Change a task (JSON Merge Patch)", "request": { "name": "Change a task (JSON Merge Patch)", "description": {}, "url": { "path": [ "tasks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_on\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "524aacb1-1314-428c-9581-0ccc24f8e294", "name": "Delete a task", "request": { "name": "Delete a task", "description": {}, "url": { "path": [ "tasks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "69889053-5c7a-4e8a-94e2-913eff3e62e1", "name": "Shop", "description": { "content": "Products, carts and orders. Money is in minor units of an ISO 4217 code: `\"price_minor\": 249900, \"currency\": \"INR\"` is ₹2,499.00. An order is placed from a cart: it takes the products' prices as they are then, and takes tracked stock.", "type": "text/plain" }, "item": [ { "id": "4e242659-16cf-4bb1-b3c8-0b086fdc3fce", "name": "List categories", "request": { "name": "List categories", "description": {}, "url": { "path": [ "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `name`." }, { "disabled": true, "key": "fields[categories]", "value": "", "description": "`fields[categories]=name,slug` returns only those fields; included items are added whole." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "099f22ca-fa82-4c73-91a5-7efc53dfe57c", "name": "Get a category", "request": { "name": "Get a category", "description": {}, "url": { "path": [ "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[categories]", "value": "", "description": "`fields[categories]=name,slug` returns only those fields; included items are added whole." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d637b962-012d-4ce3-83e6-f9080fe11eed", "name": "List products", "request": { "name": "List products", "description": {}, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[category_id]", "value": "", "description": "`filter[category_id]=` (one category), `filter[currency]=INR` (either case). `search` matches the name, sku and description." }, { "disabled": true, "key": "filter[currency]", "value": "", "description": "`filter[category_id]=` (one category), `filter[currency]=INR` (either case). `search` matches the name, sku and description." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[products]", "value": "", "description": "`fields[products]=name,price_minor` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `category`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b82205c-5122-417c-8583-98fced3af9dc", "name": "Create a product", "request": { "name": "Create a product", "description": {}, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_id\": \"\",\n \"sku\": \"\",\n \"name\": \"\",\n \"price_minor\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"stock\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53784224-1ca6-45fa-8819-7e3037c7a305", "name": "Get a product", "request": { "name": "Get a product", "description": {}, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[products]", "value": "", "description": "`fields[products]=name,price_minor` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `category`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a318f40b-777e-4635-9726-10819a11f7a0", "name": "Change a product (JSON Merge Patch)", "request": { "name": "Change a product (JSON Merge Patch)", "description": {}, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"category_id\": \"\",\n \"sku\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price_minor\": \"\",\n \"stock\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "019cf6f1-c74e-412b-b91f-b9ce22032a42", "name": "Delete a product", "request": { "name": "Delete a product", "description": {}, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dca0a5f9-9300-4d61-a5af-e436d035cee6", "name": "List carts", "request": { "name": "List carts", "description": {}, "url": { "path": [ "carts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "filter[user_id]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=active,abandoned,ordered` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[status]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=active,abandoned,ordered` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[carts]", "value": "", "description": "`fields[carts]=status,currency` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `items`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a44b81b-14fa-46e7-acbd-50f9e9a3ccea", "name": "Create a cart", "request": { "name": "Create a cart", "description": {}, "url": { "path": [ "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\",\n \"currency\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "100535d7-47db-49b3-8f04-958c965f2830", "name": "Get a cart", "request": { "name": "Get a cart", "description": {}, "url": { "path": [ "carts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[carts]", "value": "", "description": "`fields[carts]=status,currency` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `items`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6801616a-da6e-41b7-9ea7-fe6402e4bfa2", "name": "Change a cart (JSON Merge Patch)", "request": { "name": "Change a cart (JSON Merge Patch)", "description": {}, "url": { "path": [ "carts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6ae51d2-976a-4ca6-920e-ee921c9ff0d9", "name": "Delete a cart", "request": { "name": "Delete a cart", "description": {}, "url": { "path": [ "carts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa0e38c4-4e41-4317-abeb-1960e15511b7", "name": "List cart items", "request": { "name": "List cart items", "description": {}, "url": { "path": [ "cart-items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "filter[cart_id]", "value": "", "description": "`filter[cart_id]=` (one cart), `filter[product_id]=` (one product). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[product_id]", "value": "", "description": "`filter[cart_id]=` (one cart), `filter[product_id]=` (one product). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[cart-items]", "value": "", "description": "`fields[cart-items]=product_id,quantity` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `product`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ece65a32-d58f-4cb7-8bbf-67f65a02d3eb", "name": "Add a line to a cart", "request": { "name": "Add a line to a cart", "description": {}, "url": { "path": [ "cart-items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cart_id\": \"\",\n \"product_id\": \"\",\n \"quantity\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f34e890-06a5-477d-9ff3-e14cde03a823", "name": "Get a cart line", "request": { "name": "Get a cart line", "description": {}, "url": { "path": [ "cart-items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[cart-items]", "value": "", "description": "`fields[cart-items]=product_id,quantity` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `product`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfe56e1a-003f-4d8d-9eec-18285d0d5f1e", "name": "Change a cart line (JSON Merge Patch)", "request": { "name": "Change a cart line (JSON Merge Patch)", "description": {}, "url": { "path": [ "cart-items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7db27bf1-98ce-49a1-8566-572d9192c4fc", "name": "Delete a cart line", "request": { "name": "Delete a cart line", "description": {}, "url": { "path": [ "cart-items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e22ba64-1e04-4ff5-9d88-5a414d4125b6", "name": "List orders", "request": { "name": "List orders", "description": {}, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "filter[user_id]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=pending,paid` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "filter[status]", "value": "", "description": "`filter[user_id]=` (one user), `filter[status]=pending,paid` (any of). An id you cannot see gives an empty list." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[orders]", "value": "", "description": "`fields[orders]=status,total_minor` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `items`. Comma separated." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a2fba45-619d-4302-9c4f-1fd5d42d8739", "name": "Place an order from a cart", "request": { "name": "Place an order from a cart", "description": {}, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cart_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa007764-abee-4e8e-bc9d-642be1eab55c", "name": "Get a order", "request": { "name": "Get a order", "description": {}, "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[orders]", "value": "", "description": "`fields[orders]=status,total_minor` returns only those fields; included items are added whole." }, { "disabled": true, "key": "include", "value": "", "description": "Adds related items to each item, one level deep: `user`, `items`. Comma separated." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b1f0a38-22b9-495a-9c8c-d1e788b5f9bf", "name": "Change a order (JSON Merge Patch)", "request": { "name": "Change a order (JSON Merge Patch)", "description": {}, "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "The strong ETag the change is based on, from a read without `include` or from the last write; when the item changed since, the answer is 412. A weak ETag never matches.", "key": "If-Match", "value": "" }, { "disabled": true, "description": "`return=minimal` for an answer with no body, `return=representation` (the default) for the full item (RFC 7240).", "key": "Prefer", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "821462fc-d543-4ff1-ab3e-1d9b21f5ab4d", "name": "List order items", "request": { "name": "List order items", "description": {}, "url": { "path": [ "order-items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[order_id]", "value": "", "description": "`filter[order_id]=` (one order), `filter[product_id]=` (one product). An id you cannot see gives an empty list. `search` matches the name and sku." }, { "disabled": true, "key": "filter[product_id]", "value": "", "description": "`filter[order_id]=` (one order), `filter[product_id]=` (one product). An id you cannot see gives an empty list. `search` matches the name and sku." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `-created_at`." }, { "disabled": true, "key": "fields[order-items]", "value": "", "description": "`fields[order-items]=name,quantity` returns only those fields; included items are added whole." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58e80512-1c58-4bb9-bb19-6097f5963013", "name": "Get a order line", "request": { "name": "Get a order line", "description": {}, "url": { "path": [ "order-items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[order-items]", "value": "", "description": "`fields[order-items]=name,quantity` returns only those fields; included items are added whole." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "12fde5ac-754d-41dc-b2c3-95240dd41dee", "name": "Reference", "description": { "content": "ISO countries and currencies, the same for every caller and read only. No token needed.", "type": "text/plain" }, "item": [ { "id": "1f5ae9d5-8c7e-46a4-a302-c00d4d3edad5", "name": "List countries", "request": { "name": "List countries", "description": {}, "url": { "path": [ "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[region]", "value": "", "description": "`filter[region]=Asia,Europe` (any of the UN M49 continents), `filter[currency_code]=INR` (either case). `search` matches the codes and the name." }, { "disabled": true, "key": "filter[currency_code]", "value": "", "description": "`filter[region]=Asia,Europe` (any of the UN M49 continents), `filter[currency_code]=INR` (either case). `search` matches the codes and the name." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `name`." }, { "disabled": true, "key": "fields[countries]", "value": "", "description": "`fields[countries]=name,currency_code` returns only those fields; `code` is always there." }, { "disabled": true, "key": "include", "value": "", "description": "`currency` adds the currency of each item." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "810effb0-6fde-4d7c-8bf7-beeefbce2542", "name": "Get a country", "request": { "name": "Get a country", "description": {}, "url": { "path": [ "countries", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[countries]", "value": "", "description": "`fields[countries]=name,currency_code` returns only those fields; `code` is always there." }, { "disabled": true, "key": "include", "value": "", "description": "`currency` adds the currency of each item." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "code", "description": "(Required) The ISO code, in either case: `IN`." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "927b6176-bca9-40e5-8e84-3feb58539645", "name": "List currencies", "request": { "name": "List currencies", "description": {}, "url": { "path": [ "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page[size]", "value": "25", "description": "Items on one page." }, { "disabled": true, "key": "page[after]", "value": "", "description": "The cursor of the next page, from `meta.next_cursor` or the `Link` header. Treat it as opaque; it works only with the same query." }, { "disabled": true, "key": "page[number]", "value": "", "description": "Offset paging, 1 based, at most 10,000. Cannot be sent with `page[after]`. Pages can shift while you write." }, { "disabled": true, "key": "page[count]", "value": "false", "description": "`true` adds `meta.total` to a cursor page (it costs a count)." }, { "disabled": true, "key": "search", "value": "", "description": "Case-insensitive text search over the resource's text fields." }, { "disabled": true, "key": "filter[minor_unit]", "value": "", "description": "`filter[minor_unit]=0,3` (any of)." }, { "disabled": true, "key": "sort", "value": "", "description": "One field; a leading `-` sorts descending. Default `name`." }, { "disabled": true, "key": "fields[currencies]", "value": "", "description": "`fields[currencies]=name,minor_unit` returns only those fields; `code` is always there." } ], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04409460-74f4-4d21-bbc6-10f4d21f29f8", "name": "Get a currency", "request": { "name": "Get a currency", "description": {}, "url": { "path": [ "currencies", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "fields[currencies]", "value": "", "description": "`fields[currencies]=name,minor_unit` returns only those fields; `code` is always there." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "code", "description": "(Required) The ISO code, in either case: `INR`." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "317eb797-af8f-4d68-82b1-bcceddd3b5e1", "name": "Access tokens", "description": { "content": "Your API tokens. A token can make narrower tokens for one job and revoke them, so an app never needs your main token.", "type": "text/plain" }, "item": [ { "id": "a837e359-fa51-4cd5-abbd-a84043fac26f", "name": "List your tokens", "request": { "name": "List your tokens", "description": { "content": "Every token of your account, the primary one first, then the newest. An account has at most 50, so the list is one page. The values are never shown again.", "type": "text/plain" }, "url": { "path": [ "access-tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43a2633d-8ee0-4c95-93ae-8b6ca6114e49", "name": "Make a token", "request": { "name": "Make a token", "description": { "content": "The answer holds the value once; only its SHA-256 is kept. The new token gets the scopes you name, each of which the calling token must hold (403 otherwise), the calling token's rate limit, and an end within a year that is not after the calling token's own end (a year from now, or the calling token's end if sooner, when none is sent). It is never the primary token, and revoking the calling token later revokes it too.", "type": "text/plain" }, "url": { "path": [ "access-tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"scopes\": [\n \"\"\n ],\n \"expires_at\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e6c6a4c-f264-4cfd-a2b4-b41938812d99", "name": "Get one of your tokens", "request": { "name": "Get one of your tokens", "description": {}, "url": { "path": [ "access-tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "240c2322-9733-42d3-9547-a90b9cc05d10", "name": "Revoke one of your tokens", "request": { "name": "Revoke one of your tokens", "description": { "content": "The token stops working at once, and so do the tokens it made, and theirs. A token may revoke itself. The primary token cannot be revoked (409); refresh it on the site instead.", "type": "text/plain" }, "url": { "path": [ "access-tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A UUID." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c8d6ade6-4291-4ef8-b054-5a79b4627850", "name": "My data", "description": { "content": "What your account holds, and a reset to empty or to your own copy of the sample data.", "type": "text/plain" }, "item": [ { "id": "02b03fc2-d931-4645-b04c-13cf601377ae", "name": "Your counts and caps", "request": { "name": "Your counts and caps", "description": { "content": "How many rows of each resource your account holds and the most it may hold, and whether your lists show your copy of the sample data.", "type": "text/plain" }, "url": { "path": [ "my-data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c73bd7e4-37b6-41e8-995a-cea7dd3a2c19", "name": "Reset your data", "request": { "name": "Reset your data", "description": { "content": "Deletes every v3 row your account owns (users, posts, comments, tasks, products, carts and orders; your tokens stay) in one transaction. With `{\"sample_data\": true}` it then copies the sample data in as your own rows, with new ids, so you can change them; your lists show these copies instead of the sample data. This is the only way to free the order caps, as orders cannot be deleted. A reset while another reset of the account runs gets 409.", "type": "text/plain" }, "url": { "path": [ "my-data", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with `Idempotent-Replayed: true` and creates nothing; a retry while the first is still running gets 409 `conflict` with `Retry-After: 1`. The same key with another request gets 422 `idempotency_key_mismatch`. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 `conflict` with the `Location` of what the first request made.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sample_data\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2145d5c3-6ef0-4e3e-9f31-e11419c173a2", "name": "HTTP", "description": { "content": "Tools for learning HTTP and testing clients, in place of httpbin. No token needed; with one, its own rate limit applies.", "type": "text/plain" }, "item": [ { "id": "8bcedcc7-0fb5-4030-ace4-aa52779c485f", "name": "Answer with a status you choose", "request": { "name": "Answer with a status you choose", "description": { "content": "For testing how a client handles each status. 2xx and 3xx answer an `HttpStatus` body (204, 205 and 304 none); 4xx and 5xx answer Problem Details with the code `requested_status`. A 401 has `WWW-Authenticate`, a 405 `Allow` and a 429 or 503 `Retry-After`, as real ones do.", "type": "text/plain" }, "url": { "path": [ "http", "status", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "code", "description": "(Required) The status to answer, 200 to 599." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f375481-d14f-4fbd-a61c-d085f9716938", "name": "Answer after a wait", "request": { "name": "Answer after a wait", "description": { "content": "For testing loading states and timeouts. The wait stops early when the client goes away. When too many waits run at once the answer is 503 with `Retry-After`.", "type": "text/plain" }, "url": { "path": [ "http", "delay", ":ms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ms", "description": "(Required) How long to wait, 0 to 10,000 milliseconds." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b656d925-f2b5-46ce-b24e-bb3a3cf8572f", "name": "Echo a GET request", "request": { "name": "Echo a GET request", "description": {}, "url": { "path": [ "http", "echo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a0263f5-22e8-42f9-a7b3-6387a2c7248b", "name": "Echo a POST request", "request": { "name": "Echo a POST request", "description": {}, "url": { "path": [ "http", "echo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84a0522d-254f-424c-94e2-3a7e549444e5", "name": "Echo a PUT request", "request": { "name": "Echo a PUT request", "description": {}, "url": { "path": [ "http", "echo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "" } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21949437-f307-41f1-a588-f8d7475594c8", "name": "Echo a PATCH request", "request": { "name": "Echo a PATCH request", "description": {}, "url": { "path": [ "http", "echo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "" } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "430c9ec2-5f00-4138-bb8a-e90055ff3a2c", "name": "Echo a DELETE request", "request": { "name": "Echo a DELETE request", "description": {}, "url": { "path": [ "http", "echo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "" } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71dc3943-50bb-4d55-b7b1-d043a1bf305e", "name": "Show the request headers", "request": { "name": "Show the request headers", "description": { "content": "The headers the API received, without `Authorization`, `Cookie` and the headers the proxies on the way add.", "type": "text/plain" }, "url": { "path": [ "http", "headers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf755bcb-c26a-47aa-8f16-441c7b0091f8", "name": "Show your IP address", "request": { "name": "Show your IP address", "description": {}, "url": { "path": [ "http", "ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d7b4d4b-6e58-4abd-8b0c-52a734d0af18", "name": "Make a UUID", "request": { "name": "Make a UUID", "description": { "content": "A new UUIDv7, which sorts by the time it was made.", "type": "text/plain" }, "url": { "path": [ "http", "uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "18d93dd4-6831-4298-b73b-d0ce754c94f2", "name": "Stream", "description": { "content": "Your own changes as they happen, as Server-Sent Events. Read it with `fetch` or `curl -N` and your token, or with a browser `EventSource` and a single use ticket from `POST /stream/tickets`.", "type": "text/plain" }, "item": [ { "id": "7edc1075-bede-498e-abdf-4ba9aafac63a", "name": "Stream your changes", "request": { "name": "Stream your changes", "description": { "content": "Every create, update and delete in your own v3 data, as Server-Sent Events (`text/event-stream`), within about a second of the commit. Sample rows never change, so they send nothing. Each event has an `id`, an `event` name and one `data` line of JSON:\n\n- `ready`: the stream is open. Read the data you show now; every change from here on comes as an event.\n- `change`: one row was created, updated or deleted. `data` is a `ChangeEvent`; read the row at `href` for its new state.\n- `reset`: your data changed as a whole (a reset of your data) or the stream lost its place. Read the data you show again.\n\nA comment line `: heartbeat` comes every 25 seconds. The stream ends after 30 minutes, at the token's end, when the token is revoked, or when the server restarts; connect again after `retry` milliseconds and send the last `id` you got as `Last-Event-ID`. Within 5 minutes you get the events you missed, else `reset`. An event may come twice after a reconnect; drop one you have seen by its `id`. At most 3 streams per token and 10 per account on each server.\n\nA browser `EventSource` cannot send a header: get a ticket from `POST /stream/tickets` and open `?ticket=`, with `&last-event-id=` to resume. A ticket works once, also when the connect is refused (a 429, for one), so get a new one before every connect.\n", "type": "text/plain" }, "url": { "path": [ "stream", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "last-event-id", "value": "", "description": "The same as the `Last-Event-ID` header, for `EventSource` with a ticket; the header wins when both come." } ], "variable": [] }, "header": [ { "disabled": true, "description": "The `id` of the last event you got, to resume.", "key": "Last-Event-ID", "value": "" }, { "key": "Accept", "value": "text/event-stream" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bdfd317-3382-4496-b66d-f08036a14112", "name": "Get a stream ticket", "request": { "name": "Get a stream ticket", "description": { "content": "A ticket for one `GET /stream/changes?ticket=`, for a browser `EventSource`, which cannot send the token in a header. It works once, within 60 seconds, and only on the stream; the stream then checks the token that made it, as for a Bearer call. Never put your API token in a URL; a ticket is made to go there.", "type": "text/plain" }, "url": { "path": [ "stream", "tickets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e42e6394-3f39-4dd0-8048-0f33ea2f03d1", "name": "Spec", "description": { "content": "This document, for tools and code generators.", "type": "text/plain" }, "item": [ { "id": "f3a292fd-85b4-4289-a86c-9bc3311c7eaf", "name": "This spec as JSON", "request": { "name": "This spec as JSON", "description": {}, "url": { "path": [ "openapi.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8156f69-516c-48f3-a15d-17f0938dbd0e", "name": "This spec as YAML", "request": { "name": "This spec as YAML", "description": {}, "url": { "path": [ "openapi.yaml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "An ETag from an earlier answer; an unchanged item answers 304 with no body.", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/yaml" } ], "method": "GET" }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://gorest.co.in/public/v3", "key": "baseUrl" }, { "key": "bearerToken", "value": "", "type": "string", "description": "Your GoRest API token" } ], "info": { "_postman_id": "e6dac58b-54ad-4d41-9fb9-9bb9a49bbce9", "name": "GoRest v3", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "GoRest v3 is in alpha: every operation may still change. An operation marked `x-stability-level: stable` never gets a breaking change.\n\nErrors are Problem Details (RFC 9457) with a stable `code`; the codes are listed at https://www.gorest.co.in/docs/api/errors.\n\nEvery answer carries `X-Request-Id`, and the rate limit fields `RateLimit-Policy` and `RateLimit` (draft-ietf-httpapi-ratelimit-headers). With a token, the token's own limit applies; with no token, 120 calls a minute per IP. A call with no token sees only the sample data (the seed), read only. With a token you see your own rows and the seed; after `POST /my-data/reset` with sample data, your own copies instead of the seed.\n\n\nContact Support:\n Name: GoRest", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] } }