Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("limit","<integer>")
queryParams.UpdateString("page","<integer>")
queryParams.UpdateString("type","PRODUCT")
queryParams.UpdateString("number","<string>")
http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/positions",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "page": "<integer>",
' "pages": "<integer>",
' "limit": "<integer>",
' "total": "<integer>",
' "items": [
' {
' "number": "<string>",
' "description": "<string>",
' "sale_price": "<float>",
' "id": "<long>",
' "type": "PRODUCT",
' "document_note": "<string>",
' "note": null,
' "unit": null,
' "export_identifier": null,
' "export_identifier_extended": {
' "NULL": null,
' "nStb": null,
' "nStbUstID": null,
' "nStbNoneUstID": null,
' "nStbIm": null,
' "revc": null,
' "IG": null,
' "AL": null,
' "sStfr": null,
' "smallBusiness": null
' },
' "login_id": "<long>",
' "price_type": "NETTO",
' "vat_percent": 19,
' "sale_price2": null,
' "sale_price3": null,
' "sale_price4": null,
' "sale_price5": null,
' "sale_price6": null,
' "sale_price7": null,
' "sale_price8": null,
' "sale_price9": null,
' "sale_price10": null,
' "cost_price": "<float>",
' "export_cost1": null,
' "export_cost2": null,
' "group_id": "<long>",
' "stock": "NO",
' "stock_count": 0,
' "stock_limit_notify": false,
' "stock_limit_notify_frequency": "ALWAYS",
' "stock_limit": 0,
' "quantity": null,
' "archived": false
' },
' {
' "number": "<string>",
' "description": "<string>",
' "sale_price": "<float>",
' "id": "<long>",
' "type": "PRODUCT",
' "document_note": "<string>",
' "note": null,
' "unit": null,
' "export_identifier": null,
' "export_identifier_extended": {
' "NULL": null,
' "nStb": null,
' "nStbUstID": null,
' "nStbNoneUstID": null,
' "nStbIm": null,
' "revc": null,
' "IG": null,
' "AL": null,
' "sStfr": null,
' "smallBusiness": null
' },
' "login_id": "<long>",
' "price_type": "NETTO",
' "vat_percent": 19,
' "sale_price2": null,
' "sale_price3": null,
' "sale_price4": null,
' "sale_price5": null,
' "sale_price6": null,
' "sale_price7": null,
' "sale_price8": null,
' "sale_price9": null,
' "sale_price10": null,
' "cost_price": "<float>",
' "export_cost1": null,
' "export_cost2": null,
' "group_id": "<long>",
' "stock": "NO",
' "stock_count": 0,
' "stock_limit_notify": false,
' "stock_limit_notify_frequency": "ALWAYS",
' "stock_limit": 0,
' "quantity": null,
' "archived": false
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim v_number As String
Dim description As String
Dim sale_price As String
Dim id As String
Dim v_type As String
Dim document_note As String
Dim note As String
Dim unit As String
Dim export_identifier As String
Dim v_NULL As String
Dim NStb As String
Dim NStbUstID As String
Dim NStbNoneUstID As String
Dim NStbIm As String
Dim Revc As String
Dim IG As String
Dim AL As String
Dim SStfr As String
Dim SmallBusiness As String
Dim login_id As String
Dim price_type As String
Dim vat_percent As Integer
Dim sale_price2 As String
Dim sale_price3 As String
Dim sale_price4 As String
Dim sale_price5 As String
Dim sale_price6 As String
Dim sale_price7 As String
Dim sale_price8 As String
Dim sale_price9 As String
Dim sale_price10 As String
Dim cost_price As String
Dim export_cost1 As String
Dim export_cost2 As String
Dim group_id As String
Dim stock As String
Dim stock_count As Integer
Dim stock_limit_notify As Boolean
Dim stock_limit_notify_frequency As String
Dim stock_limit As Integer
Dim quantity As String
Dim archived As Boolean
Dim page As String = jResp.StringOf("page")
Dim pages As String = jResp.StringOf("pages")
Dim limit As String = jResp.StringOf("limit")
Dim total As String = jResp.StringOf("total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("items")
While i < count_i
jResp.I = i
v_number = jResp.StringOf("items[i].number")
description = jResp.StringOf("items[i].description")
sale_price = jResp.StringOf("items[i].sale_price")
id = jResp.StringOf("items[i].id")
v_type = jResp.StringOf("items[i].type")
document_note = jResp.StringOf("items[i].document_note")
note = jResp.StringOf("items[i].note")
unit = jResp.StringOf("items[i].unit")
export_identifier = jResp.StringOf("items[i].export_identifier")
v_NULL = jResp.StringOf("items[i].export_identifier_extended.NULL")
NStb = jResp.StringOf("items[i].export_identifier_extended.nStb")
NStbUstID = jResp.StringOf("items[i].export_identifier_extended.nStbUstID")
NStbNoneUstID = jResp.StringOf("items[i].export_identifier_extended.nStbNoneUstID")
NStbIm = jResp.StringOf("items[i].export_identifier_extended.nStbIm")
Revc = jResp.StringOf("items[i].export_identifier_extended.revc")
IG = jResp.StringOf("items[i].export_identifier_extended.IG")
AL = jResp.StringOf("items[i].export_identifier_extended.AL")
SStfr = jResp.StringOf("items[i].export_identifier_extended.sStfr")
SmallBusiness = jResp.StringOf("items[i].export_identifier_extended.smallBusiness")
login_id = jResp.StringOf("items[i].login_id")
price_type = jResp.StringOf("items[i].price_type")
vat_percent = jResp.IntOf("items[i].vat_percent")
sale_price2 = jResp.StringOf("items[i].sale_price2")
sale_price3 = jResp.StringOf("items[i].sale_price3")
sale_price4 = jResp.StringOf("items[i].sale_price4")
sale_price5 = jResp.StringOf("items[i].sale_price5")
sale_price6 = jResp.StringOf("items[i].sale_price6")
sale_price7 = jResp.StringOf("items[i].sale_price7")
sale_price8 = jResp.StringOf("items[i].sale_price8")
sale_price9 = jResp.StringOf("items[i].sale_price9")
sale_price10 = jResp.StringOf("items[i].sale_price10")
cost_price = jResp.StringOf("items[i].cost_price")
export_cost1 = jResp.StringOf("items[i].export_cost1")
export_cost2 = jResp.StringOf("items[i].export_cost2")
group_id = jResp.StringOf("items[i].group_id")
stock = jResp.StringOf("items[i].stock")
stock_count = jResp.IntOf("items[i].stock_count")
stock_limit_notify = jResp.BoolOf("items[i].stock_limit_notify")
stock_limit_notify_frequency = jResp.StringOf("items[i].stock_limit_notify_frequency")
stock_limit = jResp.IntOf("items[i].stock_limit")
quantity = jResp.StringOf("items[i].quantity")
archived = jResp.BoolOf("items[i].archived")
i = i + 1
End While
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "type=PRODUCT"
-d "number=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/positions
Postman Collection Item JSON
{
"name": "Fetch positions list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"positions"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "type",
"value": "PRODUCT",
"description": "Filter positions by type."
},
{
"key": "number",
"value": "<string>",
"description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"positions"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "type",
"value": "PRODUCT",
"description": "Filter positions by type."
},
{
"key": "number",
"value": "<string>",
"description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"sale_price\": \"<float>\",\n \"id\": \"<long>\",\n \"type\": \"PRODUCT\",\n \"document_note\": \"<string>\",\n \"note\": null,\n \"unit\": null,\n \"export_identifier\": null,\n \"export_identifier_extended\": {\n \"NULL\": null,\n \"nStb\": null,\n \"nStbUstID\": null,\n \"nStbNoneUstID\": null,\n \"nStbIm\": null,\n \"revc\": null,\n \"IG\": null,\n \"AL\": null,\n \"sStfr\": null,\n \"smallBusiness\": null\n },\n \"login_id\": \"<long>\",\n \"price_type\": \"NETTO\",\n \"vat_percent\": 19,\n \"sale_price2\": null,\n \"sale_price3\": null,\n \"sale_price4\": null,\n \"sale_price5\": null,\n \"sale_price6\": null,\n \"sale_price7\": null,\n \"sale_price8\": null,\n \"sale_price9\": null,\n \"sale_price10\": null,\n \"cost_price\": \"<float>\",\n \"export_cost1\": null,\n \"export_cost2\": null,\n \"group_id\": \"<long>\",\n \"stock\": \"NO\",\n \"stock_count\": 0,\n \"stock_limit_notify\": false,\n \"stock_limit_notify_frequency\": \"ALWAYS\",\n \"stock_limit\": 0,\n \"quantity\": null,\n \"archived\": false\n },\n {\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"sale_price\": \"<float>\",\n \"id\": \"<long>\",\n \"type\": \"PRODUCT\",\n \"document_note\": \"<string>\",\n \"note\": null,\n \"unit\": null,\n \"export_identifier\": null,\n \"export_identifier_extended\": {\n \"NULL\": null,\n \"nStb\": null,\n \"nStbUstID\": null,\n \"nStbNoneUstID\": null,\n \"nStbIm\": null,\n \"revc\": null,\n \"IG\": null,\n \"AL\": null,\n \"sStfr\": null,\n \"smallBusiness\": null\n },\n \"login_id\": \"<long>\",\n \"price_type\": \"NETTO\",\n \"vat_percent\": 19,\n \"sale_price2\": null,\n \"sale_price3\": null,\n \"sale_price4\": null,\n \"sale_price5\": null,\n \"sale_price6\": null,\n \"sale_price7\": null,\n \"sale_price8\": null,\n \"sale_price9\": null,\n \"sale_price10\": null,\n \"cost_price\": \"<float>\",\n \"export_cost1\": null,\n \"export_cost2\": null,\n \"group_id\": \"<long>\",\n \"stock\": \"NO\",\n \"stock_count\": 0,\n \"stock_limit_notify\": false,\n \"stock_limit_notify_frequency\": \"ALWAYS\",\n \"stock_limit\": 0,\n \"quantity\": null,\n \"archived\": false\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"positions"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "type",
"value": "PRODUCT",
"description": "Filter positions by type."
},
{
"key": "number",
"value": "<string>",
"description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
