POST api/AuthorizeReturn_V1
Authorize a return for shipment
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Return.AuthorizeReturnRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| WS_Key |
(Required) Webservice Key |
string |
None. |
| FindBy |
Required - Find Shipment by type |
WS_Repository.Models.Requests.Return.FindShipmentByType |
None. |
| ShipmentID |
(Optional) original ShipmentID - to identify the shipment - Required if FindBy = ByShipmentID |
integer |
None. |
| TrackingNumber |
(Optional) Original Shipment Tracking Number - to identify the shipment - Required if FindBy = ByTrackingNumber |
string |
None. |
| OrderNumber |
(Optional) Original Shipment Order Number - to identify the shipment - Required if FindBy = ByOrderNumber |
string |
None. |
| ReturnShipment |
Required - Return Shipment Info |
WS_Repository.Models.Requests.Return.ReturnShipmentInfo |
None. |
| eAlert |
(Optional) e-Alert info when authorization is completed |
WS_Repository.Models.Requests.Return.eAlertReturnInfo |
None. |
Request Formats
application/json, text/json
{
"WS_Key": "sample string 1",
"FindBy": 0,
"ShipmentID": 2,
"TrackingNumber": "sample string 3",
"OrderNumber": "sample string 4",
"ReturnShipment": {
"ReturnTo": 0,
"DifferentAddress": {
"PersonName": "sample string 1",
"CompanyName": "sample string 2",
"CountryCode": "sample string 3",
"ProvStateCode": "sample string 4",
"City": "sample string 5",
"Postal": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"Email": "sample string 10",
"Telephone": "sample string 11",
"IsResidential": true
},
"ReturnServiceSelection": 0,
"ReturnContents": {
"Commodities": [
{
"ID": "sample string 1",
"Description": "sample string 2",
"MadeInCountryCode": "sample string 3",
"Quantity": 4.0,
"QuantityUnitOfMeasure": "sample string 5",
"UnitValue": 6.0,
"TaxPercentage": 1.0,
"TaxesAreIncluded": true,
"TotalWeight": 7.0,
"ItemWeight": 8.0,
"ItemLength": 9.0,
"ItemWidth": 10.0,
"ItemHeight": 11.0,
"ItemMeasurementsType": 0,
"HarmonizedCode": "sample string 12",
"Canada_HarmonizedCode": "sample string 13",
"USA_HarmonizedCode": "sample string 14",
"SerialNumber": "sample string 15",
"PartNumber": "sample string 16",
"MarksOrNumbers": "sample string 17",
"SKUOrItemOrUPC": "sample string 18",
"ExportLicense": "sample string 19",
"LicenseExpireDate": "sample string 20",
"CommodityFreeTradeAgreements": [
0,
0
],
"NAFTA": true,
"NAFTACommodityDetails": {
"PreferenceCriterion": 0,
"ProducerDetermination": 0,
"NaftaNetCost": 0,
"NetCostBeginDate": "2025-12-14T10:52:09.9301019-05:00",
"NetCostEndDate": "2025-12-14T10:52:09.9301019-05:00"
},
"FDA": true,
"FCC": true,
"SenderIsProducer": true,
"Textile": true,
"TextileInformation": "sample string 26",
"FCCEntryNumber": "sample string 27",
"FCCPortOfEntry": "sample string 28",
"FCCDeviceModel": "sample string 29",
"FCCTradeName": "sample string 30",
"FCCID": "sample string 31",
"FCCDescribeRadioFrequency": "sample string 32",
"FDADescription": "sample string 33",
"IsDutiable": true,
"Manufacturer": {
"Id": "sample string 1",
"PersonName": "sample string 2",
"CompanyName": "sample string 3",
"CountryCode": "sample string 4",
"State": "sample string 5",
"City": "sample string 6",
"PostalCode": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"Address3": "sample string 10",
"Telephone": "sample string 11",
"Email": "sample string 12",
"IsResidential": true
},
"OnHoldImportBooksPerBox": 35.0,
"AccessionNumber": "sample string 36",
"DangerousGoodsInfo": {
"ContainsDangerousGoods": true,
"Accessible": true,
"RegulationSet": 0,
"RegulationLevelCode": 0,
"UN": "sample string 2",
"Class": "sample string 3",
"PackingGroup": 0,
"Authorization": "sample string 4",
"AdditionalHandlingInformation": "sample string 5",
"TechnicalName": "sample string 6",
"AdditionalDescription": "sample string 7",
"PackagingContainerType": "sample string 8",
"PackagingType": "sample string 9",
"SignatureName": "sample string 10",
"SignaturePlace": "sample string 11",
"SignatureDate": "sample string 12",
"SignatureTitle": "sample string 13",
"TransportType": 0,
"DGPackingType": 0,
"Radioactive": true,
"EmergencyPhone": "sample string 14",
"EmergencyContact": "sample string 15",
"AllPackedInOne": true,
"OverPacked": true,
"QValue": "sample string 16",
"ChemicalRecord": "sample string 17",
"HazardLabelRequired": "sample string 18",
"SubRiskClass": "sample string 19",
"TunelRestriction": true,
"AirportDeparture": "sample string 20",
"AirportDestination": "sample string 21",
"Offeror": "sample string 22",
"PackageInstructions": "sample string 23",
"ProperShippingName": "sample string 24",
"IsInfectious": true
},
"LTLClassId": "sample string 37",
"NMFCItem": "sample string 38",
"NMFCSub": "sample string 39",
"MID": "sample string 40",
"ShipAsItsOwnPackage": true,
"ShipInAnyPackage": true,
"PlantArticle": true,
"PlantArticleGenus": "sample string 44",
"PlantArticleSpecies": "sample string 45",
"PlantArticleQuantity": "sample string 46",
"PlantArticlePercentRecycled": "sample string 47",
"ECCN": "sample string 48"
},
{
"ID": "sample string 1",
"Description": "sample string 2",
"MadeInCountryCode": "sample string 3",
"Quantity": 4.0,
"QuantityUnitOfMeasure": "sample string 5",
"UnitValue": 6.0,
"TaxPercentage": 1.0,
"TaxesAreIncluded": true,
"TotalWeight": 7.0,
"ItemWeight": 8.0,
"ItemLength": 9.0,
"ItemWidth": 10.0,
"ItemHeight": 11.0,
"ItemMeasurementsType": 0,
"HarmonizedCode": "sample string 12",
"Canada_HarmonizedCode": "sample string 13",
"USA_HarmonizedCode": "sample string 14",
"SerialNumber": "sample string 15",
"PartNumber": "sample string 16",
"MarksOrNumbers": "sample string 17",
"SKUOrItemOrUPC": "sample string 18",
"ExportLicense": "sample string 19",
"LicenseExpireDate": "sample string 20",
"CommodityFreeTradeAgreements": [
0,
0
],
"NAFTA": true,
"NAFTACommodityDetails": {
"PreferenceCriterion": 0,
"ProducerDetermination": 0,
"NaftaNetCost": 0,
"NetCostBeginDate": "2025-12-14T10:52:09.9301019-05:00",
"NetCostEndDate": "2025-12-14T10:52:09.9301019-05:00"
},
"FDA": true,
"FCC": true,
"SenderIsProducer": true,
"Textile": true,
"TextileInformation": "sample string 26",
"FCCEntryNumber": "sample string 27",
"FCCPortOfEntry": "sample string 28",
"FCCDeviceModel": "sample string 29",
"FCCTradeName": "sample string 30",
"FCCID": "sample string 31",
"FCCDescribeRadioFrequency": "sample string 32",
"FDADescription": "sample string 33",
"IsDutiable": true,
"Manufacturer": {
"Id": "sample string 1",
"PersonName": "sample string 2",
"CompanyName": "sample string 3",
"CountryCode": "sample string 4",
"State": "sample string 5",
"City": "sample string 6",
"PostalCode": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"Address3": "sample string 10",
"Telephone": "sample string 11",
"Email": "sample string 12",
"IsResidential": true
},
"OnHoldImportBooksPerBox": 35.0,
"AccessionNumber": "sample string 36",
"DangerousGoodsInfo": {
"ContainsDangerousGoods": true,
"Accessible": true,
"RegulationSet": 0,
"RegulationLevelCode": 0,
"UN": "sample string 2",
"Class": "sample string 3",
"PackingGroup": 0,
"Authorization": "sample string 4",
"AdditionalHandlingInformation": "sample string 5",
"TechnicalName": "sample string 6",
"AdditionalDescription": "sample string 7",
"PackagingContainerType": "sample string 8",
"PackagingType": "sample string 9",
"SignatureName": "sample string 10",
"SignaturePlace": "sample string 11",
"SignatureDate": "sample string 12",
"SignatureTitle": "sample string 13",
"TransportType": 0,
"DGPackingType": 0,
"Radioactive": true,
"EmergencyPhone": "sample string 14",
"EmergencyContact": "sample string 15",
"AllPackedInOne": true,
"OverPacked": true,
"QValue": "sample string 16",
"ChemicalRecord": "sample string 17",
"HazardLabelRequired": "sample string 18",
"SubRiskClass": "sample string 19",
"TunelRestriction": true,
"AirportDeparture": "sample string 20",
"AirportDestination": "sample string 21",
"Offeror": "sample string 22",
"PackageInstructions": "sample string 23",
"ProperShippingName": "sample string 24",
"IsInfectious": true
},
"LTLClassId": "sample string 37",
"NMFCItem": "sample string 38",
"NMFCSub": "sample string 39",
"MID": "sample string 40",
"ShipAsItsOwnPackage": true,
"ShipInAnyPackage": true,
"PlantArticle": true,
"PlantArticleGenus": "sample string 44",
"PlantArticleSpecies": "sample string 45",
"PlantArticleQuantity": "sample string 46",
"PlantArticlePercentRecycled": "sample string 47",
"ECCN": "sample string 48"
}
]
},
"AllowRequestPickup": true,
"AuthorizationExpiryDate": "2025-12-14T10:52:09.9330955-05:00"
},
"eAlert": {
"SendEmailAlert": true,
"SendSMSAlert": true,
"OtherEmailAddress": "sample string 3",
"OtherTelephoneNumber": "sample string 4"
}
}
application/xml, text/xml
<AuthorizeReturnRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Return">
<FindBy>ByTrackingNumber</FindBy>
<OrderNumber>sample string 4</OrderNumber>
<ReturnShipment>
<AllowRequestPickup>true</AllowRequestPickup>
<AuthorizationExpiryDate>2025-12-14T10:52:09.9330955-05:00</AuthorizationExpiryDate>
<DifferentAddress>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 5</City>
<CompanyName>sample string 2</CompanyName>
<CountryCode>sample string 3</CountryCode>
<Email>sample string 10</Email>
<IsResidential>true</IsResidential>
<PersonName>sample string 1</PersonName>
<Postal>sample string 6</Postal>
<ProvStateCode>sample string 4</ProvStateCode>
<Telephone>sample string 11</Telephone>
</DifferentAddress>
<ReturnContents>
<Commodities>
<Commodity>
<AccessionNumber>sample string 36</AccessionNumber>
<Canada_HarmonizedCode>sample string 13</Canada_HarmonizedCode>
<CommodityFreeTradeAgreements xmlns:d6p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Ship">
<d6p1:FreeTradeAgreements>Other</d6p1:FreeTradeAgreements>
<d6p1:FreeTradeAgreements>Other</d6p1:FreeTradeAgreements>
</CommodityFreeTradeAgreements>
<DangerousGoodsInfo>
<Accessible>true</Accessible>
<AdditionalDescription>sample string 7</AdditionalDescription>
<AdditionalHandlingInformation>sample string 5</AdditionalHandlingInformation>
<AirportDeparture>sample string 20</AirportDeparture>
<AirportDestination>sample string 21</AirportDestination>
<AllPackedInOne>true</AllPackedInOne>
<Authorization>sample string 4</Authorization>
<ChemicalRecord>sample string 17</ChemicalRecord>
<Class>sample string 3</Class>
<ContainsDangerousGoods>true</ContainsDangerousGoods>
<DGPackingType>OTHER</DGPackingType>
<EmergencyContact>sample string 15</EmergencyContact>
<EmergencyPhone>sample string 14</EmergencyPhone>
<HazardLabelRequired>sample string 18</HazardLabelRequired>
<IsInfectious>true</IsInfectious>
<Offeror>sample string 22</Offeror>
<OverPacked>true</OverPacked>
<PackageInstructions>sample string 23</PackageInstructions>
<PackagingContainerType>sample string 8</PackagingContainerType>
<PackagingType>sample string 9</PackagingType>
<PackingGroup>NONE</PackingGroup>
<ProperShippingName>sample string 24</ProperShippingName>
<QValue>sample string 16</QValue>
<Radioactive>true</Radioactive>
<RegulationLevelCode>FullyRegulated</RegulationLevelCode>
<RegulationSet>CFR</RegulationSet>
<SignatureDate>sample string 12</SignatureDate>
<SignatureName>sample string 10</SignatureName>
<SignaturePlace>sample string 11</SignaturePlace>
<SignatureTitle>sample string 13</SignatureTitle>
<SubRiskClass>sample string 19</SubRiskClass>
<TechnicalName>sample string 6</TechnicalName>
<TransportType>PassengerAndCargoAircraft</TransportType>
<TunelRestriction>true</TunelRestriction>
<UN>sample string 2</UN>
</DangerousGoodsInfo>
<Description>sample string 2</Description>
<ECCN>sample string 48</ECCN>
<ExportLicense>sample string 19</ExportLicense>
<FCC>true</FCC>
<FCCDescribeRadioFrequency>sample string 32</FCCDescribeRadioFrequency>
<FCCDeviceModel>sample string 29</FCCDeviceModel>
<FCCEntryNumber>sample string 27</FCCEntryNumber>
<FCCID>sample string 31</FCCID>
<FCCPortOfEntry>sample string 28</FCCPortOfEntry>
<FCCTradeName>sample string 30</FCCTradeName>
<FDA>true</FDA>
<FDADescription>sample string 33</FDADescription>
<HarmonizedCode>sample string 12</HarmonizedCode>
<ID>sample string 1</ID>
<IsDutiable>true</IsDutiable>
<ItemHeight>11</ItemHeight>
<ItemLength>9</ItemLength>
<ItemMeasurementsType>Imperial</ItemMeasurementsType>
<ItemWeight>8</ItemWeight>
<ItemWidth>10</ItemWidth>
<LTLClassId>sample string 37</LTLClassId>
<LicenseExpireDate>sample string 20</LicenseExpireDate>
<MID>sample string 40</MID>
<MadeInCountryCode>sample string 3</MadeInCountryCode>
<Manufacturer>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<Address3>sample string 10</Address3>
<City>sample string 6</City>
<CompanyName>sample string 3</CompanyName>
<CountryCode>sample string 4</CountryCode>
<Email>sample string 12</Email>
<Id>sample string 1</Id>
<IsResidential>true</IsResidential>
<PersonName>sample string 2</PersonName>
<PostalCode>sample string 7</PostalCode>
<State>sample string 5</State>
<Telephone>sample string 11</Telephone>
</Manufacturer>
<MarksOrNumbers>sample string 17</MarksOrNumbers>
<NAFTA>true</NAFTA>
<NAFTACommodityDetails>
<NaftaNetCost>NC</NaftaNetCost>
<NetCostBeginDate>2025-12-14T10:52:09.9301019-05:00</NetCostBeginDate>
<NetCostEndDate>2025-12-14T10:52:09.9301019-05:00</NetCostEndDate>
<PreferenceCriterion>A</PreferenceCriterion>
<ProducerDetermination>YES</ProducerDetermination>
</NAFTACommodityDetails>
<NMFCItem>sample string 38</NMFCItem>
<NMFCSub>sample string 39</NMFCSub>
<OnHoldImportBooksPerBox>35</OnHoldImportBooksPerBox>
<PartNumber>sample string 16</PartNumber>
<PlantArticle>true</PlantArticle>
<PlantArticleGenus>sample string 44</PlantArticleGenus>
<PlantArticlePercentRecycled>sample string 47</PlantArticlePercentRecycled>
<PlantArticleQuantity>sample string 46</PlantArticleQuantity>
<PlantArticleSpecies>sample string 45</PlantArticleSpecies>
<Quantity>4</Quantity>
<QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
<SKUOrItemOrUPC>sample string 18</SKUOrItemOrUPC>
<SenderIsProducer>true</SenderIsProducer>
<SerialNumber>sample string 15</SerialNumber>
<ShipAsItsOwnPackage>true</ShipAsItsOwnPackage>
<ShipInAnyPackage>true</ShipInAnyPackage>
<TaxPercentage>1</TaxPercentage>
<TaxesAreIncluded>true</TaxesAreIncluded>
<Textile>true</Textile>
<TextileInformation>sample string 26</TextileInformation>
<TotalWeight>7</TotalWeight>
<USA_HarmonizedCode>sample string 14</USA_HarmonizedCode>
<UnitValue>6</UnitValue>
</Commodity>
<Commodity>
<AccessionNumber>sample string 36</AccessionNumber>
<Canada_HarmonizedCode>sample string 13</Canada_HarmonizedCode>
<CommodityFreeTradeAgreements xmlns:d6p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Ship">
<d6p1:FreeTradeAgreements>Other</d6p1:FreeTradeAgreements>
<d6p1:FreeTradeAgreements>Other</d6p1:FreeTradeAgreements>
</CommodityFreeTradeAgreements>
<DangerousGoodsInfo>
<Accessible>true</Accessible>
<AdditionalDescription>sample string 7</AdditionalDescription>
<AdditionalHandlingInformation>sample string 5</AdditionalHandlingInformation>
<AirportDeparture>sample string 20</AirportDeparture>
<AirportDestination>sample string 21</AirportDestination>
<AllPackedInOne>true</AllPackedInOne>
<Authorization>sample string 4</Authorization>
<ChemicalRecord>sample string 17</ChemicalRecord>
<Class>sample string 3</Class>
<ContainsDangerousGoods>true</ContainsDangerousGoods>
<DGPackingType>OTHER</DGPackingType>
<EmergencyContact>sample string 15</EmergencyContact>
<EmergencyPhone>sample string 14</EmergencyPhone>
<HazardLabelRequired>sample string 18</HazardLabelRequired>
<IsInfectious>true</IsInfectious>
<Offeror>sample string 22</Offeror>
<OverPacked>true</OverPacked>
<PackageInstructions>sample string 23</PackageInstructions>
<PackagingContainerType>sample string 8</PackagingContainerType>
<PackagingType>sample string 9</PackagingType>
<PackingGroup>NONE</PackingGroup>
<ProperShippingName>sample string 24</ProperShippingName>
<QValue>sample string 16</QValue>
<Radioactive>true</Radioactive>
<RegulationLevelCode>FullyRegulated</RegulationLevelCode>
<RegulationSet>CFR</RegulationSet>
<SignatureDate>sample string 12</SignatureDate>
<SignatureName>sample string 10</SignatureName>
<SignaturePlace>sample string 11</SignaturePlace>
<SignatureTitle>sample string 13</SignatureTitle>
<SubRiskClass>sample string 19</SubRiskClass>
<TechnicalName>sample string 6</TechnicalName>
<TransportType>PassengerAndCargoAircraft</TransportType>
<TunelRestriction>true</TunelRestriction>
<UN>sample string 2</UN>
</DangerousGoodsInfo>
<Description>sample string 2</Description>
<ECCN>sample string 48</ECCN>
<ExportLicense>sample string 19</ExportLicense>
<FCC>true</FCC>
<FCCDescribeRadioFrequency>sample string 32</FCCDescribeRadioFrequency>
<FCCDeviceModel>sample string 29</FCCDeviceModel>
<FCCEntryNumber>sample string 27</FCCEntryNumber>
<FCCID>sample string 31</FCCID>
<FCCPortOfEntry>sample string 28</FCCPortOfEntry>
<FCCTradeName>sample string 30</FCCTradeName>
<FDA>true</FDA>
<FDADescription>sample string 33</FDADescription>
<HarmonizedCode>sample string 12</HarmonizedCode>
<ID>sample string 1</ID>
<IsDutiable>true</IsDutiable>
<ItemHeight>11</ItemHeight>
<ItemLength>9</ItemLength>
<ItemMeasurementsType>Imperial</ItemMeasurementsType>
<ItemWeight>8</ItemWeight>
<ItemWidth>10</ItemWidth>
<LTLClassId>sample string 37</LTLClassId>
<LicenseExpireDate>sample string 20</LicenseExpireDate>
<MID>sample string 40</MID>
<MadeInCountryCode>sample string 3</MadeInCountryCode>
<Manufacturer>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<Address3>sample string 10</Address3>
<City>sample string 6</City>
<CompanyName>sample string 3</CompanyName>
<CountryCode>sample string 4</CountryCode>
<Email>sample string 12</Email>
<Id>sample string 1</Id>
<IsResidential>true</IsResidential>
<PersonName>sample string 2</PersonName>
<PostalCode>sample string 7</PostalCode>
<State>sample string 5</State>
<Telephone>sample string 11</Telephone>
</Manufacturer>
<MarksOrNumbers>sample string 17</MarksOrNumbers>
<NAFTA>true</NAFTA>
<NAFTACommodityDetails>
<NaftaNetCost>NC</NaftaNetCost>
<NetCostBeginDate>2025-12-14T10:52:09.9301019-05:00</NetCostBeginDate>
<NetCostEndDate>2025-12-14T10:52:09.9301019-05:00</NetCostEndDate>
<PreferenceCriterion>A</PreferenceCriterion>
<ProducerDetermination>YES</ProducerDetermination>
</NAFTACommodityDetails>
<NMFCItem>sample string 38</NMFCItem>
<NMFCSub>sample string 39</NMFCSub>
<OnHoldImportBooksPerBox>35</OnHoldImportBooksPerBox>
<PartNumber>sample string 16</PartNumber>
<PlantArticle>true</PlantArticle>
<PlantArticleGenus>sample string 44</PlantArticleGenus>
<PlantArticlePercentRecycled>sample string 47</PlantArticlePercentRecycled>
<PlantArticleQuantity>sample string 46</PlantArticleQuantity>
<PlantArticleSpecies>sample string 45</PlantArticleSpecies>
<Quantity>4</Quantity>
<QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
<SKUOrItemOrUPC>sample string 18</SKUOrItemOrUPC>
<SenderIsProducer>true</SenderIsProducer>
<SerialNumber>sample string 15</SerialNumber>
<ShipAsItsOwnPackage>true</ShipAsItsOwnPackage>
<ShipInAnyPackage>true</ShipInAnyPackage>
<TaxPercentage>1</TaxPercentage>
<TaxesAreIncluded>true</TaxesAreIncluded>
<Textile>true</Textile>
<TextileInformation>sample string 26</TextileInformation>
<TotalWeight>7</TotalWeight>
<USA_HarmonizedCode>sample string 14</USA_HarmonizedCode>
<UnitValue>6</UnitValue>
</Commodity>
</Commodities>
</ReturnContents>
<ReturnServiceSelection>AllowTheUserToChooseTheService</ReturnServiceSelection>
<ReturnTo>CurrentSender</ReturnTo>
</ReturnShipment>
<ShipmentID>2</ShipmentID>
<TrackingNumber>sample string 3</TrackingNumber>
<WS_Key>sample string 1</WS_Key>
<eAlert>
<OtherEmailAddress>sample string 3</OtherEmailAddress>
<OtherTelephoneNumber>sample string 4</OtherTelephoneNumber>
<SendEmailAlert>true</SendEmailAlert>
<SendSMSAlert>true</SendSMSAlert>
</eAlert>
</AuthorizeReturnRequest>
application/x-www-form-urlencoded
Response Information
Resource Description
WS_Repository.Models.Responses.Return.AuthorizeReturnResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Success |
Flag to idicate if the return authorization was successfully done |
boolean |
None. |
| ErrorMessage |
Error message if the return authorization fail |
string |
None. |
| ReturnUrl |
Return URL |
string |
None. |
| AuthorizationCode |
Authorization Code |
string |
None. |
| OriginalTrackingNumber |
Original Tracking Number |
string |
None. |
Response Formats
application/json, text/json
{
"Success": true,
"ErrorMessage": "sample string 2",
"ReturnUrl": "sample string 3",
"AuthorizationCode": "sample string 4",
"OriginalTrackingNumber": "sample string 5"
}
application/xml, text/xml
<AuthorizeReturnResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Return"> <AuthorizationCode>sample string 4</AuthorizationCode> <ErrorMessage>sample string 2</ErrorMessage> <OriginalTrackingNumber>sample string 5</OriginalTrackingNumber> <ReturnUrl>sample string 3</ReturnUrl> <Success>true</Success> </AuthorizeReturnResponse>