POST api/Ship/{ShipmentNumber}/Reference

Used to update a shipment's reference.

Request Information

URI Parameters

Name	Description	Type	Additional information
ShipmentNumber		integer	Required

Body Parameters

UpdateOrderReferenceParm

Name	Description	Type	Additional information
UserGUID	Unique user GUID assigned for security purposes	string	Required Max length: 36
Reference	Customer specified reference value for the shipment	string	Required Max length: 50

Name

Description

Type

Additional information

UserGUID

Unique user GUID assigned for security purposes

string

Required

Max length: 36

Reference

Customer specified reference value for the shipment

string

Required

Max length: 50

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "Reference": "sample string 2"
}

application/xml, text/xml

Sample:

<UpdateOrderReferenceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <Reference>sample string 2</Reference>
  <UserGUID>sample string 1</UserGUID>
</UpdateOrderReferenceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful	If true, then method call was successful	boolean	None.
ErrorMessage	Contains an error message is method call failed	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>