UpdateShippingDetails

Summary

Update shipping details information of the specific capture.

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

Responses

HTTP status code Model Comment
OK(200)
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"
}
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.updateShippingDetails(orderNumber, captureNumber, shippingNumber, 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::UpdateShippingDetailsRequest.deserialize_object(JSON.parse(requestAsJson))


client.orderManagement.updateShippingDetails_async(orderNumber, captureNumber, shippingNumber, 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 UpdateShippingDetailsRequest(){
  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.OrderManagementUpdateShippingDetails(orderNumber, captureNumber, shippingNumber, request);