Returns all or specific shipping details information of the capture.

Resource URL /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
HTTP method GET
Content type application/json; charset=utf-8

Input parameters

Parameter name Location Type / Model Description
orderNumber Path required
Order number
captureNumber Path required
Capture number
shippingNumber Path optional
Shipping number


HTTP status code Model Comment
OK(200) GetAllShippingDetailsResponse Get all shipping details response
BadRequest (400) array of ResponseMessage Request failed. Check response model for list of Errors.
Unauthorized (401) API user is unauthorized. Make sure X-Auth-Key header is sent.
InternalServerError (500) Request failed due internal error. Retry request later.


  "shippingDetails": [
      "shippingNumber": 1,
      "type": "Shipment",
      "shippingCompany": "UPS",
      "trackingId": "1Z9999999999999999",
      "trackingUrl": ""
      "shippingNumber": 2,
      "type": "Return",
      "shippingCompany": "UPS",
      "trackingId": "889999999999999988",
      "trackingUrl": ""
var AfterPayApi = require("./afterPay.js");
var apiKeyAuthentication = require("./api_key_filter");

var key = 'CHANGE_ME';
var client = new AfterPayApi().addFilter(apiKeyAuthentication.create(key));

client.OrderManagement.getShippingDetails(orderNumber, captureNumber, shippingNumber, 
  function(err, response, httpRequest, httpResponse) {
$LOAD_PATH.unshift File.dirname(__FILE__)
require 'after_pay.rb'
require 'json'

client ='YOUR_API_KEY'))

client.orderManagement.getShippingDetails_async(orderNumber, captureNumber, shippingNumber).then{|response|

var key = "CHANGE_ME";
var client = new OrderManagementApi(new Configuration() { DefaultHeader = new Dictionary<string, string>() { { "X-Auth-Key", key} } });

var responce = client.OrderManagementGetShippingDetails(orderNumber, captureNumber, shippingNumber);