GAINSConnect Public API

Setup & Auth
Outbound - Demand Planning
Outbound - Inventory Optimization
Outbound - Replenishment
Outbound - Master Data
Inbound - Master Data
Inbound - Transaction Data
Inbound - Tasks

GAINSConnect Public API

Setup & Auth
Outbound - Demand Planning
Outbound - Inventory Optimization
Outbound - Replenishment
Outbound - Master Data
Inbound - Master Data
Inbound - Transaction Data
Inbound - Tasks

Retrieve historical issued webhooks

get https://{env}.gainsystems.com/api/v1/webhook/history

Retrieve records of historical webhooks issued based on your settings

URL Expired

The URL for this request expired after 30 days.

Query Params

SearchDateStart

date-time

The start of the date range for which we will retrieve historical webhooks

SearchDateEnd

date-time

The end of the date range for which we will retrieve historical webhooks

Status

string

Filter by status - success, failed, no_response. Defaults to all

TrackingNumber

string

Filter by tracking number (applicable for replenishment webhooks)

Responses

Response body

object

DataType

string

Defaults to webhook

States the type of records in this payload

Data

array of objects

Data

object

WebhookId

string

Unique identifier for this webhook

IssuedAt

date-time

The Y-m-d H:i:s representation of when this webhook was issued (uses server timezone)

ResponseReceivedAt

date-time

The Y-m-d H:i:s representation of when we received a response (uses server timezone)

IssuedTo

string

The URL to which the webhook was issued

Authorization

string

The type of authorization header used as part of the webhook

Status

string

Identifies whether the request was successful, failed or did not have a response

HttpStatusCode

integer

Standard HTTP code response provided such as 2XX, 4XX, 5XX

Attempt

integer

Identifies which instance of the attempt this webhook identifies

Trigger

string

States the type of object trigger that resulted in this webhook

Response

string

The raw HTTP response received from the endpoint including headers and body and will likely be structured as an object

Payload

string

The payload sent to the endpoint

Paging

object

NextCursor

string

The cursor that identifies the next page of the payload

400

Double-check your request - you may be missing some query parameters or have provided invalid parameters

401

You are not authenticated to the API

403

You do not have access to this endpoint

404

That route doesn't exist

429

You've exceeded the rate limit

Updated 4 days ago

Set your webhook preferences

Trigger a sample webhook

Did this page help you?

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://env.gainsystems.com/api/v1/webhook/history \
3
     --header 'accept: application/json'


xxxxxxxxxx
21
 
1
{
2
  "DataType": "webhook",
3
  "Data": [
4
    {
5
      "WebhookId": "string",
6
      "IssuedAt": "2025-04-11T20:03:47.395Z",
7
      "ResponseReceivedAt": "2025-04-11T20:03:47.395Z",
8
      "IssuedTo": "string",
9
      "Authorization": "string",
10
      "Status": "string",
11
      "HttpStatusCode": 0,
12
      "Attempt": 0,
13
      "Trigger": "string",
14
      "Response": "string",
15
      "Payload": "string"
16
    }
17
  ],
18
  "Paging": {
19
    "NextCursor": "string"
20
  }
21
}

Updated 4 days ago

Set your webhook preferences

Trigger a sample webhook

Did this page help you?

GAINSConnect Public API
Setup & Auth
Retrieve configured extended data attributesget
Resend all or part of a webhook previously sentpost
Trigger a sample webhookpost
Retrieve historical issued webhooksget
Set your webhook preferencespost
Retrieve your webhook preferencesget
Check connectivity with APIget
Outbound - Demand Planning
Retrieve item sales historyget
Retrieve demand forecast as weekly bucketsget
Retrieve demand forecast as monthly bucketsget
Outbound - Inventory Optimization
Retrieve supercession relationshipsget
Retrieve BOM relationshipsget
Retrieve inventory service levelsget
Retrieve inventory policiesget
Outbound - Replenishment
Retrieve purchase requisitionsget
Retrieve work orders (WO/RWO)get
Retrieve transfers orders (TO)get
Retrieve purchase orders (PO)get
Outbound - Master Data
Retrieve location master dataget
Retrieve vendor master dataget
Retrieve customer master dataget
Inbound - Master Data
Delete price breaks for SKULspost
Load price break datapost
Load alternatives at the SKU-Location levelpost
Load inventory availability datapost
Load on-hand lots for SKULspost
Delete supercession relationshipspost
Load supercession relationshipspost
Delete BOM recordspost
Load BOM datapost
Delete SKU recordspost
Load SKU datapost
Delete SKUL recordspost
Load SKU-Location datapost
Delete location recordspost
Load location reference datapost
Delete vendor alternative recordspost
Load vendor alternatives for SKUs and vendor parameterspost
Delete vendor master recordspost
Load vendor master and reference datapost
Delete customer master recordspost
Load customer master and reference datapost
Inbound - Transaction Data
Load components for specific WO'spost
Load monthly LIA input datapost
Load weekly LIA input datapost
Delete usage transactionspost
Load usage transactionspost
Delete imported forecastspost
Load SKUL forecast datapost
Delete demand eventspost
Load demand side eventspost
Delete demand transactionspost
Load demand side transactionspost
Delete supply transactionspost
Link a supply transaction to a generated PO/TOpost
Load supply side transactions with split level datapost
Load supply side transactions (excludes split/delivery data)post
Inbound - Tasks
Cancel a specific taskpost
Get a specific taskget
Get all tasksget

GAINSConnect Public API
Setup & Auth
Retrieve configured extended data attributesget
Resend all or part of a webhook previously sentpost
Trigger a sample webhookpost
Retrieve historical issued webhooksget
Set your webhook preferencespost
Retrieve your webhook preferencesget
Check connectivity with APIget
Outbound - Demand Planning
Retrieve item sales historyget
Retrieve demand forecast as weekly bucketsget
Retrieve demand forecast as monthly bucketsget
Outbound - Inventory Optimization
Retrieve supercession relationshipsget
Retrieve BOM relationshipsget
Retrieve inventory service levelsget
Retrieve inventory policiesget
Outbound - Replenishment
Retrieve purchase requisitionsget
Retrieve work orders (WO/RWO)get
Retrieve transfers orders (TO)get
Retrieve purchase orders (PO)get
Outbound - Master Data
Retrieve location master dataget
Retrieve vendor master dataget
Retrieve customer master dataget
Inbound - Master Data
Delete price breaks for SKULspost
Load price break datapost
Load alternatives at the SKU-Location levelpost
Load inventory availability datapost
Load on-hand lots for SKULspost
Delete supercession relationshipspost
Load supercession relationshipspost
Delete BOM recordspost
Load BOM datapost
Delete SKU recordspost
Load SKU datapost
Delete SKUL recordspost
Load SKU-Location datapost
Delete location recordspost
Load location reference datapost
Delete vendor alternative recordspost
Load vendor alternatives for SKUs and vendor parameterspost
Delete vendor master recordspost
Load vendor master and reference datapost
Delete customer master recordspost
Load customer master and reference datapost
Inbound - Transaction Data
Load components for specific WO'spost
Load monthly LIA input datapost
Load weekly LIA input datapost
Delete usage transactionspost
Load usage transactionspost
Delete imported forecastspost
Load SKUL forecast datapost
Delete demand eventspost
Load demand side eventspost
Delete demand transactionspost
Load demand side transactionspost
Delete supply transactionspost
Link a supply transaction to a generated PO/TOpost
Load supply side transactions with split level datapost
Load supply side transactions (excludes split/delivery data)post
Inbound - Tasks
Cancel a specific taskpost
Get a specific taskget
Get all tasksget

200You're webhook history has been retrieved