Preview a priority change
Starts working out what every product of the store would show with these rules; nothing changes until it’s applied. Replaces a change that’s still open. 422 `invalid_rules` when the order doesn’t name every source of the store exactly once; 409 `priority_applying` while a change is being applied.
POST
Starts working out what every product of the store would show with these rules; nothing changes until it’s applied. Replaces a change that’s still open. 422 invalid_rules when the order doesn’t name every source of the store exactly once; 409 priority_applying while a change is being applied.
apiKey writeheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: write
idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255application/json- body
storeId*stringFormat
uuidrules*OK
application/json- response
id*stringFormat
uuidstoreId*stringFormat
uuidstatus*stringValue in
"previewing""ready""applying""applied""failed"rules*stale*booleancounts*error*string|nullcreatedAt*stringFormat
date-timereadyAt*|Format
date-timeappliedAt*|Format
date-timecompletedAt*|Format
date-timecurl -X POST 'https://api.postforge.dev/v1/product-priority-changes' \ -H 'Content-Type: application/json' \ -d '{ "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "rules": { "order": [ "93b532b3-a125-4cd2-9b71-9996b1e164ce" ], "fields": { "property1": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "property2": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } }}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "status": "previewing", "rules": { "order": [ "93b532b3-a125-4cd2-9b71-9996b1e164ce" ], "fields": { "property1": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "property2": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } }, "stale": true, "counts": { "products": 0, "previewed": 0, "changed": 0, "applied": 0 }, "error": "string", "createdAt": "2019-08-24T14:15:22Z", "readyAt": "2019-08-24T14:15:22Z", "appliedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z"}