Chilkat Online Tools

lianja / Marketplacer SELLER API / Create Return Shipment - Base 64 Attachments

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "{{username}}"
loHttp.Password = "{{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\"filename\": \"packing_slip.jpg\",\n\t\t\t\t\"dataBase64\": \"<BASE 64 STRING HERE>\"\n\t\t\t}\n\t\t]\n\t}\n}"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("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) + "}")
loJson.UpdateString("variables",'{' + Chr(10) + '	"input": {' + Chr(10) + '		"refundRequestId" : "UmVmdW5kUmVxdWVzdC01Mjc=",' + Chr(10) + '		"carrierId" : "U2hpcG1lbnRDYXJyaWVyLTcw",' + Chr(10) + '		"trackingNumber": "ABC-1234",' + Chr(10) + '		"shippedItems": [' + Chr(10) + '			{' + Chr(10) + '				"lineItemId" : "UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==",' + Chr(10) + '				"quantity": 1' + Chr(10) + '			}' + Chr(10) + '		],' + Chr(10) + '		"attachments": [' + Chr(10) + '			{' + Chr(10) + '				"filename": "packing_slip.jpg",' + Chr(10) + '				"dataBase64": "<BASE 64 STRING HERE>\Chr(10) + '			}' + Chr(10) + '		]' + Chr(10) + '	}' + Chr(10) + '}')

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("MARKETPLACER-API-KEY","{{api_key}}")

loResp = loHttp.PostJson3("https://bestfriendbazaar.com/graphql","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

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\"filename\": \"packing_slip.jpg\",\n\t\t\t\t\"dataBase64\": \"<BASE 64 STRING HERE>\"\n\t\t\t}\n\t\t]\n\t}\n}"}'
https://bestfriendbazaar.com/graphql

Postman Collection Item JSON

{
  "name": "Create Return Shipment - Base 64 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\"filename\": \"packing_slip.jpg\",\n\t\t\t\t\"dataBase64\": \"<BASE 64 STRING HERE>\"\n\t\t\t}\n\t\t]\n\t}\n}"
      }
    },
    "url": {
      "raw": "{{base_url}}",
      "host": [
        "{{base_url}}"
      ],
      "path": null
    },
    "description": null
  },
  "response": [
  ]
}