Returns credit requests for the authenticated user of the request
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the query string of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
BuyerUserName | string | any string | The username of the buyer |
ItemID | integer | positive # | The item ID of the item |
SellerUserName | string | any string | The username of the seller |
Sort | integer |
0 - Item ID Ascending
1 - Item ID Descending 2 - Status Ascending 3 - Status Descending 4 - Item Title Ascending 5 - Item Title Descending 6 - StartDateTime Ascending 7 - StartDateTime Descending 8 - EndingDate Ascending 9 - EndingDate Descending 10 - ReminderDateTime Ascending 11 - ReminderDateTime Descending 12 - RequestDateTime Ascending 13 - RequestDateTime Descending 14 - BuyerUserName Ascending 15 - BuyerUserName Descending 16 - SellerUserName Ascending 17 - SellerUserName Descending |
The field to sort on. Default = 0 - Item ID Ascending |
Status | integer |
0 - All
1 - Open 2 - Closed |
An enumeration specifying the credit request's status. Default = 0 - All credit requests |
TimeFrame | integer |
0 = View All Available = Default 10 = View Ended Last Week 11 = View Ended Last 2 Weeks 12 = View Ended Last 30 Days 13 = View Ended Last 60 Days 14 = View Ended Last 90 Days |
This parameter looks for credit requests in the various timeframes |
Type | integer |
0 - All credit requests
1 - Claims as Seller 2 - Claims as Buyer |
The type of credit request. Default = 0 - All credit requests |
Optional PagingParameters
If there are no errors with the input parameters, this call will respond with a 200 OK
and the following data as serialized JSON
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
Buyer | User Summary | User Summary | The Buyer of the item on the order |
CreditDateTime | datetime | A valid datetime | The date and time of the credit request |
CreditRequestType | integer | positive # | The type of credit request |
EndingDate | datetime | A valid datetime | The ending date and time of the listing |
IsRelisted | integer | positive # | 0 if item has not been relisted. 1 if item has been relisted. |
ItemID | integer | positive # | ID of the item sold |
ItemTitle | string | string | The title of the item |
ObjectID | integer | positive # | The object ID of the bank account |
RelistPrice | decimal | positive # | The price to relist the item |
RelistRequired | integer | positive # | 0 if a relist is not required for the Credit Request. 1 if a relist is required. |
ReminderDateTime | datetime | A valid datetime | The date and time of the credit request reminder |
RequestDateTime | datetime | A valid datetime | The date and time the credit request was requested |
Seller | User Summary | User Summary | The Seller of the item on the order |
StartDateTime | datetime | A valid datetime | The start date and time of the Credit Request |
Status | integer | A valid datetime | An enumeration specifying the credit request's status |
Rel | Description | Condition |
---|---|---|
self | The item details |