Chilkat Online Tools

Foxpro / ShippingEasy API / Get Orders for Specific Store

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
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')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("api_signature","{{api_signature}}")
loQueryParams.UpdateString("api_timestamp","{{api_timestamp}}")
loQueryParams.UpdateString("api_key","{{API Key}}")

loResp = loHttp.QuickRequestParams("GET","Key}}/orders",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

Curl Command

curl -G -d "api_signature=%7B%7Bapi_signature%7D%7D"
	-d "api_timestamp=%7B%7Bapi_timestamp%7D%7D"
	-d "api_key=%7B%7BAPI%20Key%7D%7D"
https://app.shippingeasy.com/api/stores/{{Store API Key}}/orders

Postman Collection Item JSON

{
  "name": "Get Orders for Specific Store",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "type": "text/javascript",
        "exec": [
          "// calculate timestamp",
          "const timestamp = parseInt(Date.now() / 1000);",
          "console.log(\"timestamp: \" + timestamp);",
          "pm.variables.set(\"api_timestamp\", timestamp);",
          "",
          "// Set your API key and API secret as Postman environment variables, your key and secret are available at https://app.shippingeasy.com/settings/api_credentials",
          "const apiKey = pm.environment.get(\"API Key\");",
          "const apiSecret = pm.environment.get(\"API Secret\");",
          "",
          "const storeApiKey = pm.environment.get(\"Store API Key\");",
          "",
          "// build signature string - https://shippingeasy.readme.io/docs/authentication-signing-requests#how-to-calculate-a-signature",
          "const signatureString = pm.request.method + \"&\" +",
          "  \"/api/stores/\" + storeApiKey + \"/orders&\" +",
          "  \"api_key=\" + apiKey + \"&\" +",
          "  \"api_timestamp=\" + timestamp;",
          "console.log(\"signature string: \" + signatureString);",
          "",
          "// generate signature",
          "const apiSignature = CryptoJS.HmacSHA256(signatureString, apiSecret).toString(CryptoJS.enc.Hex);",
          "console.log(\"api request signature: \" + apiSignature);",
          "pm.variables.set(\"api_signature\", apiSignature);"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "app.shippingeasy.com/api/stores/{{Store API Key}}/orders?api_signature={{api_signature}}&api_timestamp={{api_timestamp}}&api_key={{API Key}}",
      "host": [
        "app",
        "shippingeasy",
        "com"
      ],
      "path": [
        "api",
        "stores",
        "{{Store API Key}}",
        "orders"
      ],
      "query": [
        {
          "key": "api_signature",
          "value": "{{api_signature}}"
        },
        {
          "key": "api_timestamp",
          "value": "{{api_timestamp}}"
        },
        {
          "key": "api_key",
          "value": "{{API Key}}"
        }
      ]
    },
    "description": "Get details on the stores / marketplaces (i.e. Shopify/BigCommerce/Amazon/etc) that you have integrated with ShippingEasy.\n\nThe Manual Order store is the default / built in store for your ShippingEasy account."
  },
  "response": [
  ]
}