Chilkat Online Tools

Objective-C / Marketplacer SELLER API / Create Return Shipment - URL Attachments

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"{{username}}";
http.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}"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"query" value: @"mutation createReturnShipment ($input: ReturnShipmentCreateMutationInput!){\n	returnShipmentCreate(\n		input: $input\n	) {\n		shipment {\n			id\n			carrier {\n				name\n				trackingUrl\n			}\n			attachments {\n				url\n				alt\n			}\n		}\n		errors {\n			field\n			messages\n		}\n	}\n}"];
[json UpdateString: @"variables" value: @"{\n	\"input\": {\n		\"refundRequestId\": \"UmVmdW5kUmVxdWVzdC01Mjc=\",\n		\"carrierId\": \"U2hpcG1lbnRDYXJyaWVyLTcw\",\n		\"trackingNumber\": \"ABC-1234\",\n		\"shippedItems\": [\n			{\n				\"lineItemId\": \"UmVmdW5kUmVxdWVzdExpbmVJdGVtLTc1Ng==\",\n				\"quantity\": 1\n			}\n		],\n		\"attachments\": [\n			{\n				\"sourceUrl\": \"<YOUR PUBLIC IMAGE URL>\",\n				\"alt\": \"Packing Slip\"\n			}\n		]\n	}\n}"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"MARKETPLACER-API-KEY" value: @"{{api_key}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://bestfriendbazaar.com/graphql" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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