PureBasic / Marketplacer SELLER API / Remittances with Line Item Breakdown
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{username}}")
CkHttp::setCkPassword(http, "{{password}}")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "query": "query GetRemittancesWithLineItemBreakdown(\n\t$pageSize: Int\n\t$endCursor: String\n\t$createdSince: ISO8601DateTime\n) {\n\tremittances(\n\t\tfirst: $pageSize\n\t\tafter: $endCursor\n\t\tcreatedSince: $createdSince\n\t) {\n\t\tedges {\n\t\t\tnode {\n\t\t\t\tamountCents\n\t\t\t\t#This section pulls in invoices based on their remited date\n\n\t\t\t\tinvoice {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\t#total remittance= totalCents-comissionAmountCents-merchantFeeCents-shippingCostCents-taxTotalCents\n\t\t\t\t\ttotalCents\n\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\tmerchantFeeCents\n\t\t\t\t\tshippingCostCents\n\t\t\t\t\ttaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tid\n\t\t\t\t\t\t#total remittance= totalCents-comissionAmountCent-postageCents-taxTotalCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\tsubtotalCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tpostageCents\n\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t#This section pulls in amendments based on their remited date\n\t\t\t\tinvoiceAmendment {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\ttotalCents\n\t\t\t\t\tremittanceCents\n\t\t\t\t\tlineItemAmountTotalCents\n\t\t\t\t\tlineItemTaxTotalCents\n\t\t\t\t\tcommissionAmountTotalCents\n\t\t\t\t\tcommissionTaxTotalCents\n\t\t\t\t\tremittanceAmountTotalCents\n\t\t\t\t\tremittanceTaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tamountCents\n\t\t\t\t\t\ttaxCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\tlineItemAmountCents\n\t\t\t\t\t\tlineItemTaxCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tcommissionTaxCents\n\t\t\t\t\t\tremittanceAmountCents\n\t\t\t\t\t\tremittanceTaxCents\n\t\t\t\t\t\tlineItem {\n\t\t\t\t\t\t\tid\n\t\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t\t\texternalIds {\n\t\t\t\t\t\t\t\tkey\n\t\t\t\t\t\t\t\tvalue\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t#this section pulls in the invoice the invoice ammendment is related to so operators could tie the amendments\n\t\t\t\t\tinvoice {\n\t\t\t\t\t\tlegacyId\n\t\t\t\t\t\tremittedAt\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n",
; "variables": "{\n\t\"pageSize\": 50,\n\t\"endCursor\": \"\",\n\t\"createdSince\": \"2022-01-22T09:30:46-08:00\"\n}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"query","query GetRemittancesWithLineItemBreakdown(" + Chr(10) + " $pageSize: Int" + Chr(10) + " $endCursor: String" + Chr(10) + " $createdSince: ISO8601DateTime" + Chr(10) + ") {" + Chr(10) + " remittances(" + Chr(10) + " first: $pageSize" + Chr(10) + " after: $endCursor" + Chr(10) + " createdSince: $createdSince" + Chr(10) + " ) {" + Chr(10) + " edges {" + Chr(10) + " node {" + Chr(10) + " amountCents" + Chr(10) + " #This section pulls in invoices based on their remited date" + Chr(10) + Chr(10) + " invoice {" + Chr(10) + " id" + Chr(10) + " legacyId" + Chr(10) + " remittedAt" + Chr(10) + " #total remittance= totalCents-comissionAmountCents-merchantFeeCents-shippingCostCents-taxTotalCents" + Chr(10) + " totalCents" + Chr(10) + " commissionAmountCents" + Chr(10) + " merchantFeeCents" + Chr(10) + " shippingCostCents" + Chr(10) + " taxTotalCents" + Chr(10) + " lineItems {" + Chr(10) + " id" + Chr(10) + " #total remittance= totalCents-comissionAmountCent-postageCents-taxTotalCents" + Chr(10) + " totalCents" + Chr(10) + " itemAmountCents" + Chr(10) + " subtotalCents" + Chr(10) + " commissionAmountCents" + Chr(10) + " postageCents" + Chr(10) + " taxTotalCents" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " #This section pulls in amendments based on their remited date" + Chr(10) + " invoiceAmendment {" + Chr(10) + " id" + Chr(10) + " legacyId" + Chr(10) + " remittedAt" + Chr(10) + " totalCents" + Chr(10) + " remittanceCents" + Chr(10) + " lineItemAmountTotalCents" + Chr(10) + " lineItemTaxTotalCents" + Chr(10) + " commissionAmountTotalCents" + Chr(10) + " commissionTaxTotalCents" + Chr(10) + " remittanceAmountTotalCents" + Chr(10) + " remittanceTaxTotalCents" + Chr(10) + " lineItems {" + Chr(10) + " amountCents" + Chr(10) + " taxCents" + Chr(10) + " totalCents" + Chr(10) + " lineItemAmountCents" + Chr(10) + " lineItemTaxCents" + Chr(10) + " commissionAmountCents" + Chr(10) + " commissionTaxCents" + Chr(10) + " remittanceAmountCents" + Chr(10) + " remittanceTaxCents" + Chr(10) + " lineItem {" + Chr(10) + " id" + Chr(10) + " itemAmountCents" + Chr(10) + " taxTotalCents" + Chr(10) + " externalIds {" + Chr(10) + " key" + Chr(10) + " value" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " #this section pulls in the invoice the invoice ammendment is related to so operators could tie the amendments" + Chr(10) + " invoice {" + Chr(10) + " legacyId" + Chr(10) + " remittedAt" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + "}" + Chr(10))
CkJsonObject::ckUpdateString(json,"variables","{" + Chr(10) + " " + Chr(34) + "pageSize" + Chr(34) + ": 50," + Chr(10) + " " + Chr(34) + "endCursor" + Chr(34) + ": " + Chr(34) + Chr(34) + "," + Chr(10) + " " + Chr(34) + "createdSince" + Chr(34) + ": " + Chr(34) + "2022-01-22T09:30:46-08:00\Chr(10) + "}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"MARKETPLACER-API-KEY","{{api_key}}")
resp.i = CkHttp::ckPostJson3(http,"https://bestfriendbazaar.com/graphql","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-u '{{username}}:{{password}}'
-H "MARKETPLACER-API-KEY: {{api_key}}"
-H "Content-Type: application/json"
--data-raw '{"query":"query GetRemittancesWithLineItemBreakdown(\n\t$pageSize: Int\n\t$endCursor: String\n\t$createdSince: ISO8601DateTime\n) {\n\tremittances(\n\t\tfirst: $pageSize\n\t\tafter: $endCursor\n\t\tcreatedSince: $createdSince\n\t) {\n\t\tedges {\n\t\t\tnode {\n\t\t\t\tamountCents\n\t\t\t\t#This section pulls in invoices based on their remited date\n\n\t\t\t\tinvoice {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\t#total remittance= totalCents-comissionAmountCents-merchantFeeCents-shippingCostCents-taxTotalCents\n\t\t\t\t\ttotalCents\n\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\tmerchantFeeCents\n\t\t\t\t\tshippingCostCents\n\t\t\t\t\ttaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tid\n\t\t\t\t\t\t#total remittance= totalCents-comissionAmountCent-postageCents-taxTotalCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\tsubtotalCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tpostageCents\n\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t#This section pulls in amendments based on their remited date\n\t\t\t\tinvoiceAmendment {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\ttotalCents\n\t\t\t\t\tremittanceCents\n\t\t\t\t\tlineItemAmountTotalCents\n\t\t\t\t\tlineItemTaxTotalCents\n\t\t\t\t\tcommissionAmountTotalCents\n\t\t\t\t\tcommissionTaxTotalCents\n\t\t\t\t\tremittanceAmountTotalCents\n\t\t\t\t\tremittanceTaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tamountCents\n\t\t\t\t\t\ttaxCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\tlineItemAmountCents\n\t\t\t\t\t\tlineItemTaxCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tcommissionTaxCents\n\t\t\t\t\t\tremittanceAmountCents\n\t\t\t\t\t\tremittanceTaxCents\n\t\t\t\t\t\tlineItem {\n\t\t\t\t\t\t\tid\n\t\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t\t\texternalIds {\n\t\t\t\t\t\t\t\tkey\n\t\t\t\t\t\t\t\tvalue\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t#this section pulls in the invoice the invoice ammendment is related to so operators could tie the amendments\n\t\t\t\t\tinvoice {\n\t\t\t\t\t\tlegacyId\n\t\t\t\t\t\tremittedAt\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n","variables":"{\n\t\"pageSize\": 50,\n\t\"endCursor\": \"\",\n\t\"createdSince\": \"2022-01-22T09:30:46-08:00\"\n}"}'
https://bestfriendbazaar.com/graphql
Postman Collection Item JSON
{
"name": "Remittances with Line Item Breakdown",
"request": {
"method": "POST",
"header": [
{
"key": "MARKETPLACER-API-KEY",
"value": "{{api_key}}",
"type": "text"
},
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query GetRemittancesWithLineItemBreakdown(\n\t$pageSize: Int\n\t$endCursor: String\n\t$createdSince: ISO8601DateTime\n) {\n\tremittances(\n\t\tfirst: $pageSize\n\t\tafter: $endCursor\n\t\tcreatedSince: $createdSince\n\t) {\n\t\tedges {\n\t\t\tnode {\n\t\t\t\tamountCents\n\t\t\t\t#This section pulls in invoices based on their remited date\n\n\t\t\t\tinvoice {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\t#total remittance= totalCents-comissionAmountCents-merchantFeeCents-shippingCostCents-taxTotalCents\n\t\t\t\t\ttotalCents\n\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\tmerchantFeeCents\n\t\t\t\t\tshippingCostCents\n\t\t\t\t\ttaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tid\n\t\t\t\t\t\t#total remittance= totalCents-comissionAmountCent-postageCents-taxTotalCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\tsubtotalCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tpostageCents\n\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t#This section pulls in amendments based on their remited date\n\t\t\t\tinvoiceAmendment {\n\t\t\t\t\tid\n\t\t\t\t\tlegacyId\n\t\t\t\t\tremittedAt\n\t\t\t\t\ttotalCents\n\t\t\t\t\tremittanceCents\n\t\t\t\t\tlineItemAmountTotalCents\n\t\t\t\t\tlineItemTaxTotalCents\n\t\t\t\t\tcommissionAmountTotalCents\n\t\t\t\t\tcommissionTaxTotalCents\n\t\t\t\t\tremittanceAmountTotalCents\n\t\t\t\t\tremittanceTaxTotalCents\n\t\t\t\t\tlineItems {\n\t\t\t\t\t\tamountCents\n\t\t\t\t\t\ttaxCents\n\t\t\t\t\t\ttotalCents\n\t\t\t\t\t\tlineItemAmountCents\n\t\t\t\t\t\tlineItemTaxCents\n\t\t\t\t\t\tcommissionAmountCents\n\t\t\t\t\t\tcommissionTaxCents\n\t\t\t\t\t\tremittanceAmountCents\n\t\t\t\t\t\tremittanceTaxCents\n\t\t\t\t\t\tlineItem {\n\t\t\t\t\t\t\tid\n\t\t\t\t\t\t\titemAmountCents\n\t\t\t\t\t\t\ttaxTotalCents\n\t\t\t\t\t\t\texternalIds {\n\t\t\t\t\t\t\t\tkey\n\t\t\t\t\t\t\t\tvalue\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t#this section pulls in the invoice the invoice ammendment is related to so operators could tie the amendments\n\t\t\t\t\tinvoice {\n\t\t\t\t\t\tlegacyId\n\t\t\t\t\t\tremittedAt\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n",
"variables": "{\n\t\"pageSize\": 50,\n\t\"endCursor\": \"\",\n\t\"createdSince\": \"2022-01-22T09:30:46-08:00\"\n}"
}
},
"url": {
"raw": "{{base_url}}",
"host": [
"{{base_url}}"
],
"path": null
},
"description": null
},
"response": [
]
}
