Chilkat Online Tools

Foxpro / Marketplacer SELLER API / Create Return Shipment - URL Attachments

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
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\"sourceUrl\": \"<YOUR PUBLIC IMAGE URL>\",\n\t\t\t\t\"alt\": \"Packing Slip\"\n\t\t\t}\n\t\t]\n\t}\n}"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
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) + '				"sourceUrl": "<YOUR PUBLIC IMAGE URL>",' + CHR(10) + '				"alt": "Packing Slip\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 = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
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\"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": [
  ]
}