Fetch API (v3.0: 3.25.0.4)
For differences between versions, see Changelog.
https://fetch.yellowdogsoftware.com/api/v3/
Request
This endpoint allows for bulk upserting of TPItems.
Creating a TPItems
The fields that are required to create a TPLocation are type
and code
Updating a TPItems
include the query parameter, upsert=true
When a validation error occurs, the entire request will fail.
Additional Notes
Processing the item changes can take up to 10 minutes to process due to the amount of background processing that needs to be done.
- application/json-patch+json
- application/json
- text/json
- application/*+json
- Production server
https://fetch.yellowdogsoftware.com/api/v3/third-party/{syncId}/items
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://fetch.yellowdogsoftware.com/api/v3/third-party/{syncId}/items?upsert=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"type": "string",
"code": "string",
"alternateCode": "string",
"description": "string",
"canMapToRecipes": true,
"canMapToTransactions": true,
"parentCode": "string"
}
]'
Request
This endpoint allows for bulk upserting of TPLocations.
Creating a TPLocations
The fields that are required to create a TPLocation are type
and code
Updating a TPLocations
include the query parameter, upsert=true
When a validation error occurs, the entire request will fail.
- application/json-patch+json
- application/json
- text/json
- application/*+json
- Production server
https://fetch.yellowdogsoftware.com/api/v3/third-party/{syncId}/locations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://fetch.yellowdogsoftware.com/api/v3/third-party/{syncId}/locations?upsert=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"type": "string",
"code": "string",
"description": "string",
"parentCode": "string",
"alternateCode": "string",
"storeId": "string",
"storeCode": "string"
}
]'