Below is an example of the JSON response body that ShipStation is expecting when an /orders call is made for order information. You can find detailed definitions of the fields in the Orders.
GET /orders?page=2 HTTP/1.1
Host: api.my-store.com
Authorization: Basic ZGVtbzpwQDU1dzByZA==
Accept: application/json
curl -iX GET 'https://api.my-store.com/orders?page=2' \
-H 'Authorization: Basic ZGVtbzpwQDU1dzByZA==' \
-H 'Accept: application/json' \
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "api.my-store.com")
$headers.Add("Authorization", "Basic ZGVtbzpwQDU1dzByZA==")
$headers.Add("Accept", "application/json")
$response = Invoke-RestMethod 'https://api.my-store.com/orders?page=2' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
var myHeaders = new Headers();
myHeaders.append("Host", "api.my-store.com");
myHeaders.append("Authorization", "Basic ZGVtbzpwQDU1dzByZA==");
myHeaders.append("Accept", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.my-store.com/orders?page=2", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://api.my-store.com/orders?page=2',
'headers': {
'Host': 'api.my-store.com',
'Authorization': 'Basic ZGVtbzpwQDU1dzByZA==',
'Accept': 'application/json'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.my-store.com/orders?page=2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Host: api.my-store.com",
"Authorization: Basic ZGVtbzpwQDU1dzByZA==",
"Accept: application/json"
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import requests
url = "https://api.my-store.com/orders?page=2"
payload = {}
headers = {
'Host': 'api.my-store.com',
'Authorization': 'Basic ZGVtbzpwQDU1dzByZA==',
'Accept': 'application/json'
}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
require "uri"
require "net/http"
url = URI("https://api.my-store.com/orders?page=2")
https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Host"] = "api.my-store.com"
request["Authorization"] = "Basic ZGVtbzpwQDU1dzByZA=="
request["Accept"] = "application/json"
response = https.request(request)
puts response.read_body
var client = new RestClient("https://api.my-store.com/orders?page=2");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "api.my-store.com");
request.AddHeader("Authorization", "Basic ZGVtbzpwQDU1dzByZA==");
request.AddHeader("Accept", "application/json");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.my-store.com/orders?page=2")
.method("GET", null)
.addHeader("Host", "api.my-store.com")
.addHeader("Authorization", "Basic ZGVtbzpwQDU1dzByZA==")
.addHeader("Accept", "application/json")
.build();
Response response = client.newCall(request).execute();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.my-store.com/orders?page=2"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
}
req.Header.Add("Host", "api.my-store.com")
req.Header.Add("Authorization", "Basic ZGVtbzpwQDU1dzByZA==")
req.Header.Add("Accept", "application/json")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
}
#import <Foundation/Foundation.h>
dispatch_semaphore_t sema = dispatch_semaphore_create(0);
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.my-store.com/orders?page=2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Host": @"api.my-store.com",
@"Authorization": @"Basic ZGVtbzpwQDU1dzByZA==",
@"Accept": @"application/json"
};
[request setAllHTTPHeaderFields:headers];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSError *parseError = nil;
NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
NSLog(@"%@",responseDictionary);
dispatch_semaphore_signal(sema);
}
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
import Foundation
var semaphore = DispatchSemaphore (value: 0)
var request = URLRequest(url: URL(string: "https://api.my-store.com/orders?page=2")!,timeoutInterval: Double.infinity)
request.addValue("api.my-store.com", forHTTPHeaderField: "Host")
request.addValue("Basic ZGVtbzpwQDU1dzByZA==", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Accept")
request.httpMethod = "GET"
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
semaphore.signal()
}
task.resume()
semaphore.wait()
{
"page": 2,
"pages": 7,
"orders": [
{
"order_id": "QsPJ9R-CfY4 BjnieMw68-Gb9TW9yp",
"order_source_code": "shopify",
"created_at": "2020-01-17T05:50:23.000Z",
"modified_at": "2020-01-17T05:50:23.000Z",
"status": "awaiting_shipment",
"fulfillment_status": "partially_fulfilled",
"buyer": {
"buyer_id": "username123",
"name": "John Doe",
"phone": "111-111-1111",
"email": "[email protected]"
},
"ship_to": {
"name": "Amanda Miller",
"phone": "555-555-5555",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
},
"tax": {
"amount": 16.37,
"currency": "usd"
},
"shipping_price": {
"amount": 22.10,
"currency": "usd"
},
"price_adjustments": [
{
"type": "gift_certificate",
"amount": {
"amount": -10,
"currency": "usd"
}
},
{
"type": "fee",
"amount": {
"amount": 12,
"currency": "usd"
}
}
],
"total_price": {
"amount": 115.44,
"currency": "usd"
},
"payment_status": "payment_in_process",
"payment_method": "credit_card",
"items": [
{
"item_id": "9TWjnieMw6-89ypRCfY4XBGb-QsPJ9",
"fulfillment_status": "partially_fulfilled",
"name": "Wonder Widget",
"sku": "KS944RUR",
"quantity": 3,
"weight": {
"value": 7,
"unit": "pound"
},
"unit_price": {
"amount": 24.99,
"currency": "usd"
},
"total_price": {
"amount": 74.97,
"currency": "usd"
},
"shipping_preferences": {
"confirmation": "adult_signature",
"expedited_service": true,
"contains_alcohol": false,
"delivery_date": "2020-01-20",
"saturday_delivery": true,
"insured_value": {
"amount": 100,
"currency": "usd"
}
},
"links": {
"self": "https://my-store.com/orders/123456/items/456789",
"category": "https://my-store.com/widgets",
"product": "https://my-store.com/product/123456",
"image": "https://my-store.com/product/123456/image.jpg",
"thumbnail": "https://my-store.com/product/123456/small.jpg",
"video": "https://my-store.com/product/123456/video",
"tracking": "https://my-store.com/orders/123456/track"
}
}
],
"links": {
"self": "https://my-store.com/orders/123456"
},
"notes": [
{
"type": "instructions",
"text": "Please make sure it gets here by Dec. 22nd!"
},
{
"type": "internal_notes",
"text": "Ship by December 18th via Priority Mail."
}
]
}
]
}
