PureBasic / Marketplacer SELLER API / Create Return Shipment - URL Attachments
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": "mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){\n\treturnShipmentCreate(\n\t\tinput: $input\n\t) {\n\t\tshipment {\n\t\t\tid\n\t\t\tcarrier {\n\t\t\t\tname\n\t\t\t\ttrackingUrl\n\t\t\t}\n\t\t\tattachments {\n\t\t\t\turl\n\t\t\t\talt\n\t\t\t}\n\t\t}\n\t\terrors {\n\t\t\tfield\n\t\t\tmessages\n\t\t}\n\t}\n}",
; "variables": "{\n\t\"input\": {\n\t\t\"refundRequestId\": \"UmVmdW5kUmVxdWVzdC01Mjc=\",\n\t\t\"carrierId\": \"U2hpcG1lbnRDYXJyaWVyLTcw\",\n\t\t\"trackingNumber\": \"ABC-1234\",\n\t\t\"shippedItems\": [\n\t\t\t{\n\t\t\t\t\"lineItemId\": \"UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==\",\n\t\t\t\t\"quantity\": 1\n\t\t\t}\n\t\t],\n\t\t\"attachments\": [\n\t\t\t{\n\t\t\t\t\"sourceUrl\": \"<YOUR PUBLIC IMAGE URL>\",\n\t\t\t\t\"alt\": \"Packing Slip\"\n\t\t\t}\n\t\t]\n\t}\n}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"query","mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){" + Chr(10) + " returnShipmentCreate(" + Chr(10) + " input: $input" + Chr(10) + " ) {" + Chr(10) + " shipment {" + Chr(10) + " id" + Chr(10) + " carrier {" + Chr(10) + " name" + Chr(10) + " trackingUrl" + Chr(10) + " }" + Chr(10) + " attachments {" + Chr(10) + " url" + Chr(10) + " alt" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " errors {" + Chr(10) + " field" + Chr(10) + " messages" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + "}")
CkJsonObject::ckUpdateString(json,"variables","{" + Chr(10) + " " + Chr(34) + "input" + Chr(34) + ": {" + Chr(10) + " " + Chr(34) + "refundRequestId" + Chr(34) + ": " + Chr(34) + "UmVmdW5kUmVxdWVzdC01Mjc=" + Chr(34) + "," + Chr(10) + " " + Chr(34) + "carrierId" + Chr(34) + ": " + Chr(34) + "U2hpcG1lbnRDYXJyaWVyLTcw" + Chr(34) + "," + Chr(10) + " " + Chr(34) + "trackingNumber" + Chr(34) + ": " + Chr(34) + "ABC-1234" + Chr(34) + "," + Chr(10) + " " + Chr(34) + "shippedItems" + Chr(34) + ": [" + Chr(10) + " {" + Chr(10) + " " + Chr(34) + "lineItemId" + Chr(34) + ": " + Chr(34) + "UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==" + Chr(34) + "," + Chr(10) + " " + Chr(34) + "quantity" + Chr(34) + ": 1" + Chr(10) + " }" + Chr(10) + " ]," + Chr(10) + " " + Chr(34) + "attachments" + Chr(34) + ": [" + Chr(10) + " {" + Chr(10) + " " + Chr(34) + "sourceUrl" + Chr(34) + ": " + Chr(34) + "<YOUR PUBLIC IMAGE URL>" + Chr(34) + "," + Chr(10) + " " + Chr(34) + "alt" + Chr(34) + ": " + Chr(34) + "Packing Slip\Chr(10) + " }" + Chr(10) + " ]" + Chr(10) + " }" + 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":"mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){\n\treturnShipmentCreate(\n\t\tinput: $input\n\t) {\n\t\tshipment {\n\t\t\tid\n\t\t\tcarrier {\n\t\t\t\tname\n\t\t\t\ttrackingUrl\n\t\t\t}\n\t\t\tattachments {\n\t\t\t\turl\n\t\t\t\talt\n\t\t\t}\n\t\t}\n\t\terrors {\n\t\t\tfield\n\t\t\tmessages\n\t\t}\n\t}\n}","variables":"{\n\t\"input\": {\n\t\t\"refundRequestId\": \"UmVmdW5kUmVxdWVzdC01Mjc=\",\n\t\t\"carrierId\": \"U2hpcG1lbnRDYXJyaWVyLTcw\",\n\t\t\"trackingNumber\": \"ABC-1234\",\n\t\t\"shippedItems\": [\n\t\t\t{\n\t\t\t\t\"lineItemId\": \"UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==\",\n\t\t\t\t\"quantity\": 1\n\t\t\t}\n\t\t],\n\t\t\"attachments\": [\n\t\t\t{\n\t\t\t\t\"sourceUrl\": \"<YOUR PUBLIC IMAGE URL>\",\n\t\t\t\t\"alt\": \"Packing Slip\"\n\t\t\t}\n\t\t]\n\t}\n}"}'
https://bestfriendbazaar.com/graphql
Postman Collection Item JSON
{
"name": "Create Return Shipment - URL Attachments",
"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": "mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){\n\treturnShipmentCreate(\n\t\tinput: $input\n\t) {\n\t\tshipment {\n\t\t\tid\n\t\t\tcarrier {\n\t\t\t\tname\n\t\t\t\ttrackingUrl\n\t\t\t}\n\t\t\tattachments {\n\t\t\t\turl\n\t\t\t\talt\n\t\t\t}\n\t\t}\n\t\terrors {\n\t\t\tfield\n\t\t\tmessages\n\t\t}\n\t}\n}",
"variables": "{\n\t\"input\": {\n\t\t\"refundRequestId\": \"UmVmdW5kUmVxdWVzdC01Mjc=\",\n\t\t\"carrierId\": \"U2hpcG1lbnRDYXJyaWVyLTcw\",\n\t\t\"trackingNumber\": \"ABC-1234\",\n\t\t\"shippedItems\": [\n\t\t\t{\n\t\t\t\t\"lineItemId\": \"UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==\",\n\t\t\t\t\"quantity\": 1\n\t\t\t}\n\t\t],\n\t\t\"attachments\": [\n\t\t\t{\n\t\t\t\t\"sourceUrl\": \"<YOUR PUBLIC IMAGE URL>\",\n\t\t\t\t\"alt\": \"Packing Slip\"\n\t\t\t}\n\t\t]\n\t}\n}"
}
},
"url": {
"raw": "{{base_url}}",
"host": [
"{{base_url}}"
],
"path": null
},
"description": null
},
"response": [
]
}
