Get a deep diff between two entity versions or draft vs published.
1 min
GET
https://api.upstartcommerce.com/pim/diff
Query Parameters
- entity_typestringrequiredDescriptionAllowedproductvariant
- entity_idstringrequiredDescription
- modestringrequiredDescriptionAllowedversiondraft
- from_versionintegerDescriptionMinimum1
- to_versionintegerDescriptionMinimum1
- fieldsstringDescription
- ignore_fieldsstringDescription
- pageintegerDescriptionDefault1Minimum1
- page_sizeintegerDescriptionDefault50Minimum1Maximum200
Responses
200
- object
Response Headers
- Allow
- ETag
- Cache-Control
- Content-Type
- Location
422
- object
curl
curl --request GET \
--url 'https://api.upstartcommerce.com/pim/diff?entity_type=product&entity_id=string&mode=version&page=1&page_size=50' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/pim/diff?entity_type=product&entity_id=string&mode=version&page=1&page_size=50", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/pim/diff?entity_type=product&entity_id=string&mode=version&page=1&page_size=50")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/pim/diff?entity_type=product&entity_id=string&mode=version&page=1&page_size=50"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Diff result.
{}422
// Unprocessable entity.
{}