Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "{{username}}"
$oHttp.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}"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("query","mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){" & @LF & "	returnShipmentCreate(" & @LF & "		input: $input" & @LF & "	) {" & @LF & "		shipment {" & @LF & "			id" & @LF & "			carrier {" & @LF & "				name" & @LF & "				trackingUrl" & @LF & "			}" & @LF & "			attachments {" & @LF & "				url" & @LF & "				alt" & @LF & "			}" & @LF & "		}" & @LF & "		errors {" & @LF & "			field" & @LF & "			messages" & @LF & "		}" & @LF & "	}" & @LF & "}")
$oJson.UpdateString("variables","{" & @LF & "	""input"": {" & @LF & "		""refundRequestId"": ""UmVmdW5kUmVxdWVzdC01Mjc=""," & @LF & "		""carrierId"": ""U2hpcG1lbnRDYXJyaWVyLTcw""," & @LF & "		""trackingNumber"": ""ABC-1234""," & @LF & "		""shippedItems"": [" & @LF & "			{" & @LF & "				""lineItemId"": ""UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==""," & @LF & "				""quantity"": 1" & @LF & "			}" & @LF & "		]," & @LF & "		""attachments"": [" & @LF & "			{" & @LF & "				""sourceUrl"": ""<YOUR PUBLIC IMAGE URL>""," & @LF & "				""alt"": ""Packing Slip\@LF & "			}" & @LF & "		]" & @LF & "	}" & @LF & "}")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "MARKETPLACER-API-KEY","{{api_key}}"

Local $oResp = $oHttp.PostJson3("https://bestfriendbazaar.com/graphql","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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": [
  ]
}