| GET | /Queries/CR_Warehouse | Retrieves a list of creditor warehouses. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WarehouseID | query | string | No | |
| WarehouseIDStartsWith | query | string | No | |
| WarehouseIDEndsWith | query | string | No | |
| WarehouseIDContains | query | string | No | |
| WarehouseIDLike | query | string | No | |
| WarehouseIDBetween | query | string[] | No | |
| WarehouseIDIn | query | string[] | No | |
| CreditorID | query | string | No | |
| CreditorIDStartsWith | query | string | No | |
| CreditorIDEndsWith | query | string | No | |
| CreditorIDContains | query | string | No | |
| CreditorIDLike | query | string | No | |
| CreditorIDBetween | query | string[] | No | |
| CreditorIDIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| Address1 | query | string | No | |
| Address1StartsWith | query | string | No | |
| Address1EndsWith | query | string | No | |
| Address1Contains | query | string | No | |
| Address1Like | query | string | No | |
| Address1Between | query | string[] | No | |
| Address1In | query | string[] | No | |
| Address2 | query | string | No | |
| Address2StartsWith | query | string | No | |
| Address2EndsWith | query | string | No | |
| Address2Contains | query | string | No | |
| Address2Like | query | string | No | |
| Address2Between | query | string[] | No | |
| Address2In | query | string[] | No | |
| Address3 | query | string | No | |
| Address3StartsWith | query | string | No | |
| Address3EndsWith | query | string | No | |
| Address3Contains | query | string | No | |
| Address3Like | query | string | No | |
| Address3Between | query | string[] | No | |
| Address3In | query | string[] | No | |
| Address4 | query | string | No | |
| Address4StartsWith | query | string | No | |
| Address4EndsWith | query | string | No | |
| Address4Contains | query | string | No | |
| Address4Like | query | string | No | |
| Address4Between | query | string[] | No | |
| Address4In | query | string[] | No | |
| PostCode | query | string | No | |
| PostCodeStartsWith | query | string | No | |
| PostCodeEndsWith | query | string | No | |
| PostCodeContains | query | string | No | |
| PostCodeLike | query | string | No | |
| PostCodeBetween | query | string[] | No | |
| PostCodeIn | query | string[] | No | |
| Notes | query | string | No | |
| NotesStartsWith | query | string | No | |
| NotesEndsWith | query | string | No | |
| NotesContains | query | string | No | |
| NotesLike | query | string | No | |
| NotesBetween | query | string[] | No | |
| NotesIn | query | string[] | No | |
| CourierDetails | query | string | No | |
| CourierDetailsStartsWith | query | string | No | |
| CourierDetailsEndsWith | query | string | No | |
| CourierDetailsContains | query | string | No | |
| CourierDetailsLike | query | string | No | |
| CourierDetailsBetween | query | string[] | No | |
| CourierDetailsIn | query | string[] | No | |
| DefaultItem | query | bool? | No | |
| DefaultDelDays | query | short? | No | |
| DefaultDelDaysGreaterThanOrEqualTo | query | short? | No | |
| DefaultDelDaysGreaterThan | query | short? | No | |
| DefaultDelDaysLessThan | query | short? | No | |
| DefaultDelDaysLessThanOrEqualTo | query | short? | No | |
| DefaultDelDaysNotEqualTo | query | short? | No | |
| DefaultDelDaysBetween | query | Nullable<Int16>[] | No | |
| DefaultDelDaysIn | query | Nullable<Int16>[] | No | |
| Country | query | string | No | |
| CountryStartsWith | query | string | No | |
| CountryEndsWith | query | string | No | |
| CountryContains | query | string | No | |
| CountryLike | query | string | No | |
| CountryBetween | query | string[] | No | |
| CountryIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WarehouseID | form | string | No | |
| CreditorID | form | string | No | |
| Description | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| Address4 | form | string | No | |
| PostCode | form | string | No | |
| Notes | form | string | No | |
| CourierDetails | form | string | No | |
| DefaultItem | form | bool? | No | |
| DefaultDelDays | form | short? | No | |
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/CR_Warehouse HTTP/1.1 Host: localhost Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"WarehouseID":"String","CreditorID":"String","Description":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Notes":"String","CourierDetails":"String","DefaultItem":false,"DefaultDelDays":0,"Country":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}