Request deletion of SKU-location records

post

https://{env}.gainsystems.com/api/v1/skus-locations/delete

Requests the deletion of one or more SKU-location records. Deleting a SKU-location removes planning history that cannot be restored, so the request is held until you approve it; it is not applied on receipt.

The response returns a task in PendingReview. At that point nothing has been deleted or sent for processing. Approve or reject the task with PUT /api/v1/tasks/{taskId}. A rejected task moves to RejectedNotApproved and the records are never deleted.

Once approved, the deletion is queued for the next scheduled GAINS run, and the task moves through Queued / Processing / Completed.

To follow the outcome, either poll GET /api/v1/tasks/{taskId}, or subscribe to the task_status_update webhook trigger and filter on Status (for example Status = "PendingReview" or Status = "Completed"). While the task is still PendingReview you can withdraw the request with POST /api/v1/tasks/{taskId}/cancel.

A maximum of 1000 records may be submitted per request.

GAINS X version requirement:

Min: 10.0-ER2610

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

Idempotency-Key

string

length ≤ 255

Optional key that makes a retry safe. A request repeating a key already used on this endpoint within the last 24 hours is refused with 400 and nothing is submitted again. A UUID is recommended; at most 255 characters

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

202Accepted; poll the returned task for progress

207Partially accepted; rejected records are listed in the response

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

422Nothing was accepted and no task was created. Either every record failed validation, and the body lists each one under RejectedRecords with Status "RejectedFailedProcessing"; or the payload was empty or held more than 1000 records, and the body carries a Reason

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

500Unexpected server error

503GAINS is temporarily unavailable, or inbound integration is switched off in GAINS X: GAINS X could not be reached or returned an error, or your credentials could not be checked. Retry later, or contact your GAINS representative if inbound integration is not enabled

504GAINS X did not respond in time. Retry later