ShipStation API V1

https://www.shipstation.com/docs/api/
Admin
ShipStation API V1 allows developers to build applications that interface with the ShipStation...
Tokens:192,205
Snippets:486
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### List Products Request Examples

Source: https://www.shipstation.com/docs/api/products/list

Examples of how to perform a GET request to the products endpoint across multiple languages and tools.

```http
GET /products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
```

```bash
curl -iX GET 'https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize' \
-H 'Authorization: __YOUR_AUTH_HERE__'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/products?sku=sku&name=name&productCategoryId=productCategoryId&productTypeId=productTypeId&tagId=tagId&startDate=startDate&endDate=endDate&showInactive=showInactive&sortBy=sortBy&sortDir=sortDir&page=page&pageSize=pageSize");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

--------------------------------

### List Orders By Tag Request Examples

Source: https://www.shipstation.com/docs/api/orders/list-by-tag

Various implementation examples for the GET request to list orders by tag.

```http
GET /orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
```

```bash
curl -iX GET 'https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize' \
-H 'Authorization: __YOUR_AUTH_HERE__'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/orders/listbytag?orderStatus=orderStatus&tagId=tagId&page=page&pageSize=pageSize")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Get Customer API Request Examples

Source: https://www.shipstation.com/docs/api/customers/get-customer

Examples for retrieving customer data via the ShipStation API. Replace __YOUR_AUTH_HERE__ with your actual authentication credentials.

```http
GET /customers/{customerId} HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
```

```bash
curl -iX GET https://ssapi.shipstation.com/customers/{customerId} \
-H 'Authorization: __YOUR_AUTH_HERE__'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/customers/{customerId}' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/customers/{customerId}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/customers/{customerId}',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/customers/%7BcustomerId%7D",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/customers/{customerId}"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/customers/{customerId}")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/customers/{customerId}");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/customers/{customerId}")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/customers/%7BcustomerId%7D"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```

--------------------------------

### Get Store API Request Examples

Source: https://www.shipstation.com/docs/api/stores/get-store

Various language implementations for performing a GET request to retrieve store details.

```http
GET /stores/storeId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__

```

```bash
curl -iX GET https://ssapi.shipstation.com/stores/storeId \
-H 'Authorization: __YOUR_AUTH_HERE__'

```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/stores/storeId' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/stores/storeId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/stores/storeId',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/stores/storeId",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/stores/storeId"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/stores/storeId")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/stores/storeId");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/stores/storeId")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/stores/storeId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```

--------------------------------

### Get Store Refresh Status Request Examples

Source: https://www.shipstation.com/docs/api/stores/get-refresh-status

Various implementation examples for the GET /stores/getrefreshstatus endpoint.

```http
GET /stores/getrefreshstatus?storeId=storeId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
```

```bash
curl -iX GET 'https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId' \
-H 'Authorization: __YOUR_AUTH_HERE__'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/stores/getrefreshstatus?storeId=storeId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```

--------------------------------

### List Fulfillments API Request Examples

Source: https://www.shipstation.com/docs/api/fulfillments/list-fulfillments

Examples for performing a GET request to the fulfillments endpoint. Replace __YOUR_AUTH_HERE__ with your actual API credentials.

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/fulfillments?fulfillmentId=%7BfulfillmentId%7D&orderId=%7BorderId%7D&orderNumber=%7BorderNumber%7D&trackingNumber=%7BtrackingNumber%7D&recipientName=%7BrecipientName%7D&createDateStart=%7BcreateDateStart%7D&createDateEnd=%7BcreateDateEnd%7D&shipDateStart=%7BshipDateStart%7D&shipDateEnd=%7BshipDateEnd%7D&sortBy=%7BsortBy%7D&sortDir=%7BsortDir%7D&page=%7Bpage%7D&pageSize=%7BpageSize%7D"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```

```objective-c
#import <Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://ssapi.shipstation.com/fulfillments?fulfillmentId=%7BfulfillmentId%7D&orderId=%7BorderId%7D&orderNumber=%7BorderNumber%7D&trackingNumber=%7BtrackingNumber%7D&recipientName=%7BrecipientName%7D&createDateStart=%7BcreateDateStart%7D&createDateEnd=%7BcreateDateEnd%7D&shipDateStart=%7BshipDateStart%7D&shipDateEnd=%7BshipDateEnd%7D&sortBy=%7BsortBy%7D&sortDir=%7BsortDir%7D&page=%7Bpage%7D&pageSize=%7BpageSize%7D"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"ssapi.shipstation.com",
  @"Authorization": @"__YOUR_AUTH_HERE__"
};

[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);
```

--------------------------------

### Get Product Request Examples

Source: https://www.shipstation.com/docs/api/products/get-product

Various language implementations for retrieving product details via the ShipStation API.

```http
GET /products/productId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__

```

```bash
curl -iX GET https://ssapi.shipstation.com/products/productId \
-H 'Authorization: __YOUR_AUTH_HERE__'

```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/products/productId' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/products/productId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/products/productId',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/products/productId",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/products/productId"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/products/productId")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/products/productId");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/products/productId")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/products/productId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```

--------------------------------

### OkHttp Client Initialization

Source: https://www.shipstation.com/docs/api/orders/create-update-multiple-orders

Basic setup for an OkHttp client instance.

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
```

--------------------------------

### Register Account Request Examples

Source: https://www.shipstation.com/docs/api/accounts/create

Examples of how to register a new account using various HTTP clients and programming languages.

```http
POST /accounts/registeraccount HTTP/1.1
Host: ssapi.shipstation.com
Content-Type: application/json

{
  "firstName": "John",
  "lastName": "Smith",
  "email": "jsmithtest@gmail.com",
  "password": "testpw1234",
  "shippingOriginCountryCode": "US",
  "companyName": "Droid Repair LLC",
  "addr1": "542 Midichlorian Rd.",
  "addr2": "",
  "city": "Austin",
  "state": "TX",
  "zip": "78703",
  "countryCode": "US",
  "phone": "5124111234"
}
```

```bash
curl -iX POST https://ssapi.shipstation.com/accounts/registeraccount \
-H 'Content-Type: application/json' \
-d '{
  "firstName": "John",
  "lastName": "Smith",
  "email": "jsmithtest@gmail.com",
  "password": "testpw1234",
  "shippingOriginCountryCode": "US",
  "companyName": "Droid Repair LLC",
  "addr1": "542 Midichlorian Rd.",
  "addr2": "",
  "city": "Austin",
  "state": "TX",
  "zip": "78703",
  "countryCode": "US",
  "phone": "5124111234"
}'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Content-Type", "application/json")

$body = "{`n  `"firstName`": `"John`",`n  `"lastName`": `"Smith`",`n  `"email`": `"jsmithtest@gmail.com`",`n  `"password`": `"testpw1234`",`n  `"shippingOriginCountryCode`": `"US`",`n  `"companyName`": `"Droid Repair LLC`",`n  `"addr1`": `"542 Midichlorian Rd.`",`n  `"addr2`": `"`",`n  `"city`": `"Austin`",`n  `"state`": `"TX`",`n  `"zip`": `"78703`",`n  `"countryCode`": `"US`",`n  `"phone`": `"5124111234`"`n}"

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/accounts/registeraccount' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"firstName":"John","lastName":"Smith","email":"jsmithtest@gmail.com","password":"testpw1234","shippingOriginCountryCode":"US","companyName":"Droid Repair LLC","addr1":"542 Midichlorian Rd.","addr2":"","city":"Austin","state":"TX","zip":"78703","countryCode":"US","phone":"5124111234"});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/accounts/registeraccount", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

--------------------------------

### List Stores Request Examples

Source: https://www.shipstation.com/docs/api/stores/list

Various language implementations for performing a GET request to the /stores endpoint.

```http
GET /stores?showInactive=showInactive&marketplaceId=marketplaceId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
```

```bash
curl -iX GET 'https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId' \
-H 'Authorization: __YOUR_AUTH_HERE__'
```

```powershell
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId' -Method 'GET' -Headers $headers -Body $body
$response | ConvertTo-Json
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId",
  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: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```python
import requests

url = "https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId"

payload = {}
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

```ruby
require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"

response = https.request(request)
puts response.read_body
```

```csharp
var client = new RestClient("https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId")
  .method("GET", null)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .build();
Response response = client.newCall(request).execute();
```

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/stores?showInactive=showInactive&marketplaceId=marketplaceId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
```
Tokens:
Raw