AddShippingDetails

Summary

Add new shipping details information to the capture.

Resource URL	/api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details
HTTP method	POST
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
request	Body	AddShippingDetailsRequest	required Request object

Responses

HTTP status code	Model	Comment
OK(200)	AddShippingDetailsResponse	Add 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.

Examples

{
  "type": "Shipment",
  "shippingCompany": "UPS",
  "trackingId": "1Z9999999999999999",
  "trackingUrl": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z9999999999999999"
}

{
  "shippingNumber": 13335
}

var AfterPayApi = require("./afterPay.js");
var apiKeyAuthentication = require("./api_key_filter");

var key = 'CHANGE_ME';
var client = new AfterPayApi().addFilter(apiKeyAuthentication.create(key));
var request = {
  "type": "Shipment",
  "shippingCompany": "UPS",
  "trackingId": "1Z9999999999999999",
  "trackingUrl": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z9999999999999999"
};

client.OrderManagement.addShippingDetails(orderNumber, captureNumber, request, 
  function(err, response, httpRequest, httpResponse) {
  });

$LOAD_PATH.unshift File.dirname(__FILE__)
require 'after_pay.rb'
require 'json'

client = AfterPayApi::AfterPay.new(AfterPayApi::ApiKeyCredentials.new('YOUR_API_KEY'))

requestAsJson = '{"type":"Shipment","shippingCompany":"UPS","trackingId":"1Z9999999999999999","trackingUrl":"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z9999999999999999"}'
request = AfterPayApi::Models::AddShippingDetailsRequest.deserialize_object(JSON.parse(requestAsJson))


client.orderManagement.addShippingDetails_async(orderNumber, captureNumber, request).then{|response|

}.execute.wait

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

var request = new AddShippingDetailsRequest(){
  OrderNumber = "ORDER0001",
  CaptureNumber = "CAPTURE0001",
  ShippingNumber = 1,
  Type = ShippingType.Shipment,
  ShippingCompany = "UPS",
  TrackingId = "1Z9999999999999999",
  TrackingUrl = "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z9999999999999999"
};

var responce = client.OrderManagementAddShippingDetails(orderNumber, captureNumber, request);