Notify The Order Source

Example

POST /v-beta/sales_orders/:id/notify_shipped

Full Sales Order Notification

POST /v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "tracking_number": "9374869901600064074368",
  "carrier_code": "stamps_com"
}

curl -iX POST https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-H 'Content-Type: application/json' \
-d '{
  "tracking_number": "9374869901600064074368",
  "carrier_code": "stamps_com"
}'

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "api.shipengine.com")
$headers.Add("API-Key", "__YOUR_API_KEY_HERE__")
$headers.Add("Content-Type", "application/json")

$body = "{`n  `"tracking_number`": `"9374869901600064074368`",`n  `"carrier_code`": `"stamps_com`"`n}"

$response = Invoke-RestMethod 'https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

var myHeaders = new Headers();
myHeaders.append("Host", "api.shipengine.com");
myHeaders.append("API-Key", "__YOUR_API_KEY_HERE__");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"tracking_number":"9374869901600064074368","carrier_code":"stamps_com"});

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

fetch("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped',
  'headers': {
    'Host': 'api.shipengine.com',
    'API-Key': '__YOUR_API_KEY_HERE__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"tracking_number":"9374869901600064074368","carrier_code":"stamps_com"})

};
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.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Host: api.shipengine.com",
    "API-Key: __YOUR_API_KEY_HERE__",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"

payload = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}"
headers = {
  'Host': 'api.shipengine.com',
  'API-Key': '__YOUR_API_KEY_HERE__',
  'Content-Type': 'application/json'
}

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

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

require "uri"
require "net/http"

url = URI("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")

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

request = Net::HTTP::Post.new(url)
request["Host"] = "api.shipengine.com"
request["API-Key"] = "__YOUR_API_KEY_HERE__"
request["Content-Type"] = "application/json"
request.body = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}"

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

var client = new RestClient("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Host", "api.shipengine.com");
request.AddHeader("API-Key", "__YOUR_API_KEY_HERE__");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}");
Request request = new Request.Builder()
  .url("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")
  .method("POST", body)
  .addHeader("Host", "api.shipengine.com")
  .addHeader("API-Key", "__YOUR_API_KEY_HERE__")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

package main

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

func main() {

  url := "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"
  method := "POST"

  payload := strings.NewReader("{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}")

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

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "api.shipengine.com")
  req.Header.Add("API-Key", "__YOUR_API_KEY_HERE__")
  req.Header.Add("Content-Type", "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.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"api.shipengine.com",
  @"API-Key": @"__YOUR_API_KEY_HERE__",
  @"Content-Type": @"application/json"
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];

[request setHTTPMethod:@"POST"];

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)

let parameters = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")!,timeoutInterval: Double.infinity)
request.addValue("api.shipengine.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_API_KEY_HERE__", forHTTPHeaderField: "API-Key")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

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()

Partial Sales Order Notification

POST /v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "tracking_number": "9374869901600064074368",
  "carrier_code": "stamps_com",
  "sales_order_items": [
    {
      "sales_order_item_id": "0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742",
      "quantity": 1
    }
  ]
}

curl -iX POST https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-H 'Content-Type: application/json' \
-d '{
  "tracking_number": "9374869901600064074368",
  "carrier_code": "stamps_com",
  "sales_order_items": [
    {
      "sales_order_item_id": "0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742",
      "quantity": 1
    }
  ]
}'

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "api.shipengine.com")
$headers.Add("API-Key", "__YOUR_API_KEY_HERE__")
$headers.Add("Content-Type", "application/json")

$body = "{`n  `"tracking_number`": `"9374869901600064074368`",`n  `"carrier_code`": `"stamps_com`",`n  `"sales_order_items`": [`n    {`n      `"sales_order_item_id`": `"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742`",`n      `"quantity`": 1`n    }`n  ]`n}"

$response = Invoke-RestMethod 'https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

var myHeaders = new Headers();
myHeaders.append("Host", "api.shipengine.com");
myHeaders.append("API-Key", "__YOUR_API_KEY_HERE__");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"tracking_number":"9374869901600064074368","carrier_code":"stamps_com","sales_order_items":[{"sales_order_item_id":"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742","quantity":1}]});

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

fetch("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped',
  'headers': {
    'Host': 'api.shipengine.com',
    'API-Key': '__YOUR_API_KEY_HERE__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"tracking_number":"9374869901600064074368","carrier_code":"stamps_com","sales_order_items":[{"sales_order_item_id":"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742","quantity":1}]})

};
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.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}",
  CURLOPT_HTTPHEADER => array(
    "Host: api.shipengine.com",
    "API-Key: __YOUR_API_KEY_HERE__",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"

payload = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}"
headers = {
  'Host': 'api.shipengine.com',
  'API-Key': '__YOUR_API_KEY_HERE__',
  'Content-Type': 'application/json'
}

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

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

require "uri"
require "net/http"

url = URI("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")

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

request = Net::HTTP::Post.new(url)
request["Host"] = "api.shipengine.com"
request["API-Key"] = "__YOUR_API_KEY_HERE__"
request["Content-Type"] = "application/json"
request.body = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}"

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

var client = new RestClient("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Host", "api.shipengine.com");
request.AddHeader("API-Key", "__YOUR_API_KEY_HERE__");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}");
Request request = new Request.Builder()
  .url("https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")
  .method("POST", body)
  .addHeader("Host", "api.shipengine.com")
  .addHeader("API-Key", "__YOUR_API_KEY_HERE__")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

package main

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

func main() {

  url := "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"
  method := "POST"

  payload := strings.NewReader("{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}")

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

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "api.shipengine.com")
  req.Header.Add("API-Key", "__YOUR_API_KEY_HERE__")
  req.Header.Add("Content-Type", "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.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"api.shipengine.com",
  @"API-Key": @"__YOUR_API_KEY_HERE__",
  @"Content-Type": @"application/json"
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];

[request setHTTPMethod:@"POST"];

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)

let parameters = "{\n  \"tracking_number\": \"9374869901600064074368\",\n  \"carrier_code\": \"stamps_com\",\n  \"sales_order_items\": [\n    {\n      \"sales_order_item_id\": \"0ca0a452-2f7b-5a50-8b28-4e0b8d1fa742\",\n      \"quantity\": 1\n    }\n  ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.shipengine.com/v-beta/sales_orders/bf2a2717-dd70-5428-a688-98bdc4bcb7e7/notify_shipped")!,timeoutInterval: Double.infinity)
request.addValue("api.shipengine.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_API_KEY_HERE__", forHTTPHeaderField: "API-Key")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

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()

info

Refresh your order source

After updating your sales order with tracking information, don't forget to refresh the order source to see the updated fulfillment status!