Fetch API (v3.0: 3.25.0.4)
For differences between versions, see Changelog.
https://fetch.yellowdogsoftware.com/api/v3/
- application/json-patch+json
- application/json
- text/json
- application/*+json
Object of the Request to be created
- Production server
https://fetch.yellowdogsoftware.com/api/v3/requests
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://fetch.yellowdogsoftware.com/api/v3/requests \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"lines": [
{
"commdocLineID": "9cb09c6a-a112-4d73-94fe-fbd96496e1dd",
"commdocID": "cb99375d-6433-4b86-97cb-443f2b96b6b7",
"backLinkLineID": "6e13b4f1-3f38-4d49-a5c5-95b5e01905d0",
"itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
"vendorPrice": 0,
"lastVendorPrice": 0,
"quantity": 0,
"lineNumber": 0,
"notes": "string",
"converted": "string",
"computedCost": 0,
"rowDeleted": true
}
],
"doCommit": true,
"RequestType": "string",
"commit": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"thirdPartyID": "string",
"docNumber": "string",
"reference": "string",
"description": "string",
"instructions": "string",
"totalAmount": 0.1,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"vendor": "string",
"createdByUser": "string",
"notes": "string",
"store": "string",
"committed": "2019-08-24T14:15:22Z",
"committedByUser": "string",
"needBy": "2019-08-24T14:15:22Z"
}'
Rate limiting quota exceeded
Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.
To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.
For further information see Rate Limiting Section of Getting Started of api documentation site.
No content
- Production server
https://fetch.yellowdogsoftware.com/api/v3/requests/{id}/Commit
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://fetch.yellowdogsoftware.com/api/v3/requests/{id}/Commit' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Rate limiting quota exceeded
Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.
To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.
For further information see Rate Limiting Section of Getting Started of api documentation site.
No content
- Production server
https://fetch.yellowdogsoftware.com/api/v3/requests/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://fetch.yellowdogsoftware.com/api/v3/requests/{id}?PageNumber=0&PageSize=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "id": "string", "code": "string", "description": "string", "dueAt": "2019-08-24T14:15:22Z", "instructions": "string", "notes": "string", "reference": "string", "requestedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "status": 0, "store": { "code": "string", "description": "string", "id": "string", "requestEmailAddress": "string" }, "requestor": { "code": "string", "id": "string", "name": "string", "email": "string" }, "requestType": 0, "lines": { "id": "string", "count": 0, "uniqueItemCount": 0, "totalQuantity": 0.1, "totalVendorPrice": 0.1, "nodes": [ … ] } }
- application/json-patch+json
- application/json
- text/json
- application/*+json
Any alterations to the Request
- Production server
https://fetch.yellowdogsoftware.com/api/v3/requests/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://fetch.yellowdogsoftware.com/api/v3/requests/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"lines": [
{
"commdocLineID": "9cb09c6a-a112-4d73-94fe-fbd96496e1dd",
"commdocID": "cb99375d-6433-4b86-97cb-443f2b96b6b7",
"backLinkLineID": "6e13b4f1-3f38-4d49-a5c5-95b5e01905d0",
"itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
"vendorPrice": 0,
"lastVendorPrice": 0,
"quantity": 0,
"lineNumber": 0,
"notes": "string",
"converted": "string",
"computedCost": 0,
"rowDeleted": true
}
],
"doCommit": true,
"RequestType": "string",
"commit": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"thirdPartyID": "string",
"docNumber": "string",
"reference": "string",
"description": "string",
"instructions": "string",
"totalAmount": 0.1,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"vendor": "string",
"createdByUser": "string",
"notes": "string",
"store": "string",
"committed": "2019-08-24T14:15:22Z",
"committedByUser": "string",
"needBy": "2019-08-24T14:15:22Z"
}'
Rate limiting quota exceeded
Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.
To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.
For further information see Rate Limiting Section of Getting Started of api documentation site.
No content