dfm-rivt-internal-api
RequestAttrbutes
Y – Required (Must be set in the input)
O – Optional (May be sent in addition to required fields).
/getRanStncr
Request Parameters
Method: POST
Query params:
| Query Attribute | Type | Required | Example | Description |
|---|---|---|---|---|
| page | positiveNumber | N | Min 1 | Page number for the search criteria, This attribute enables the pagination. Helps to fetch the records starting with specific Index value |
| limit | positiveNumber | N | Max 500 | Page limit for the search criteria, Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
Request Body :
| Object | Attribute | Type | Required | Example | Description |
|---|---|---|---|---|---|
| sourceProfileId | Number | N | "sourceProfileId": 2 | Unique distributor source profile id generated at WIPS | |
| resellerAccountNumber | String | N | "resellerAccountNumber": "89421" | resellerAccountNumber | |
| distiTheater | String | N | "distiTheater": "USA" | distiTheater | |
| soldToName | String | N | "soldToName": "TEST" | soldToName | |
| partnerBeGeoId | Number | N | "partnerBeGeoId": 1234 | partnerBeGeoId | |
| partnerSiteId | Number | N | "partnerSiteId": 123 | partnerSiteId |
/getRanStn
Request Parameters
Method: POST
Content-Type: application/json
Query params:
| Query Attribute | Type | Required | Example | Description |
|---|---|---|---|---|
| page | positiveNumber | N | Min 1 | Page number for the search criteria, This attribute enables the pagination. Helps to fetch the records starting with specific Index value |
| limit | positiveNumber | N | Max 500 | Page limit for the search criteria, Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
Request Body :
| Object | Attribute | Type | Required | Example | Description |
|---|---|---|---|---|---|
| sourceProfileId | Number | N | "sourceProfileId": 2 | Unique distributor source profile id generated at WIPS | |
| resellerAccountNumber | String | N | "resellerAccountNumber": "89421" | resellerAccountNumber | |
| distiTheater | String | N | "distiTheater": "USA" | distiTheater | |
| soldToName | String | N | "soldToName": "TEST" | soldToName | |
| partnerBeGeoId | Number | N | "partnerBeGeoId": 1234 | partnerBeGeoId |
/validateReseller
Request Parameters
Method: POST
Content-Type: application/json
Request Body :
| Object | Attribute | Type | Required | Example | Description |
|---|---|---|---|---|---|
| service | String | Y | "service":"validateReseller" | service | |
| entity | resellerAccNo | String | Y | "resellerAccNo": "89421" | resellerAccNo |
| entity | customerNumber | String | Y | "customerNumber": "123445" | ERP Account Number |