Stock decisions

DELETE/v1/shops/{id}/baskets

Delete one product group for good: DELETE /v1/shops/{id}/baskets in the Panlytics API.

What it does

Destructive: it cannot be undone, so an agent asks the person before it calls this.

The group and any decision about it are gone; a later scan may propose it again. Ask the person before you call this, and say which group goes.

Who may call it

A key whose maker's role holds sheet (edit the sheet and upload a report), after the fence, for the shop or category it names.

Request

HTTP
DELETE https://panlytics.net/api/v1/shops/{id}/baskets

Parameters

NameInTypeRequiredWhat it is
idpathintegerYesThe shop's id.
purposequerystringYesThe group to delete, by its purpose.
AuthorizationheaderstringYesBearer, a space, then the key.

Example request

curl -X DELETE https://panlytics.net/api/v1/shops/12/baskets \
  -H "Authorization: Bearer $PANLYTICS_KEY"

Response

200: The answer, as JSON.

FieldTypeAlways thereWhat it is
purposestringYesThe group that was changed.
doneboolean (always true)YesAlways true.

Example response

200
{
  "purpose": "Breakfast",
  "done": true
}

Errors

A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.

StatusCodeWhenWhat to do
400api.invalidA path id, a query parameter, a header or a body field is missing or not valid. detail names the field.Read that endpoint in the API reference, correct the field and call again.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability).Ask the person who gave you the key to make a new one.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach.Ask the CEO for a role that allows it, or call it for a shop or category the role reaches.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
403refused.demoThe key belongs to a shared demo account, which may not change anything.Use a key made in a real company account.
404not_found.saidNothing with that id in the key's company. An id of another company answers the same.Check the id. List the shop or category it belongs to and take the id from there.
409scan.noneNothing has been scanned yet.Run a scan first, then decide which groups you stock.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.