getReturn
Returns a single return
Use this API to retrieve complete details about a single return, given the return's id.
/returns/{id}
Usage and SDK Samples
curl -X GET "https://api.sandbox.dub.yojaka.xp.sellers.a2z.com/v1/returns/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReturnsListingRetrievalApi;
import java.io.File;
import java.util.*;
public class ReturnsListingRetrievalApiExample {
public static void main(String[] args) {
ReturnsListingRetrievalApi apiInstance = new ReturnsListingRetrievalApi();
String xAmzAccessToken = xAmzAccessToken_example; // String | The LWA access token for authorizing the request
String id = id_example; // String | The return's Amazon Yojaka assigned id.
try {
ReturnItem result = apiInstance.getReturn(xAmzAccessToken, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReturnsListingRetrievalApi#getReturn");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ReturnsListingRetrievalApi;
public class ReturnsListingRetrievalApiExample {
public static void main(String[] args) {
ReturnsListingRetrievalApi apiInstance = new ReturnsListingRetrievalApi();
String xAmzAccessToken = xAmzAccessToken_example; // String | The LWA access token for authorizing the request
String id = id_example; // String | The return's Amazon Yojaka assigned id.
try {
ReturnItem result = apiInstance.getReturn(xAmzAccessToken, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReturnsListingRetrievalApi#getReturn");
e.printStackTrace();
}
}
}
String *xAmzAccessToken = xAmzAccessToken_example; // The LWA access token for authorizing the request
String *id = id_example; // The return's Amazon Yojaka assigned id.
ReturnsListingRetrievalApi *apiInstance = [[ReturnsListingRetrievalApi alloc] init];
// Returns a single return
[apiInstance getReturnWith:xAmzAccessToken
id:id
completionHandler: ^(ReturnItem output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AmazonYojakaApiReturnsModel = require('amazon_yojaka_api_returns_model');
var api = new AmazonYojakaApiReturnsModel.ReturnsListingRetrievalApi()
var xAmzAccessToken = xAmzAccessToken_example; // {{String}} The LWA access token for authorizing the request
var id = id_example; // {{String}} The return's Amazon Yojaka assigned id.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getReturn(xAmzAccessToken, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getReturnExample
{
public void main()
{
var apiInstance = new ReturnsListingRetrievalApi();
var xAmzAccessToken = xAmzAccessToken_example; // String | The LWA access token for authorizing the request
var id = id_example; // String | The return's Amazon Yojaka assigned id.
try
{
// Returns a single return
ReturnItem result = apiInstance.getReturn(xAmzAccessToken, id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ReturnsListingRetrievalApi.getReturn: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiReturnsListingRetrievalApi();
$xAmzAccessToken = xAmzAccessToken_example; // String | The LWA access token for authorizing the request
$id = id_example; // String | The return's Amazon Yojaka assigned id.
try {
$result = $api_instance->getReturn($xAmzAccessToken, $id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ReturnsListingRetrievalApi->getReturn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReturnsListingRetrievalApi;
my $api_instance = WWW::SwaggerClient::ReturnsListingRetrievalApi->new();
my $xAmzAccessToken = xAmzAccessToken_example; # String | The LWA access token for authorizing the request
my $id = id_example; # String | The return's Amazon Yojaka assigned id.
eval {
my $result = $api_instance->getReturn(xAmzAccessToken => $xAmzAccessToken, id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ReturnsListingRetrievalApi->getReturn: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ReturnsListingRetrievalApi()
xAmzAccessToken = xAmzAccessToken_example # String | The LWA access token for authorizing the request
id = id_example # String | The return's Amazon Yojaka assigned id.
try:
# Returns a single return
api_response = api_instance.get_return(xAmzAccessToken, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ReturnsListingRetrievalApi->getReturn: %s\n" % e)
Parameters
Name | Description |
---|---|
id* |
String
The return's Amazon Yojaka assigned id.
Required
|
Name | Description |
---|---|
X-Amz-Access-Token* |
String
The LWA access token for authorizing the request
Required
|
Responses
Status: 200 - Success. The response contains details of a single return.
Contains information about an return that is being processed by Amazon SmartConnect.
Marketplace Channel specific custom attributes for the return. These attributes are not mandatory and each channel can provide it differently. Connectors can read them based on the type provided to parse the value.
Status: 400 - Bad request. The response contains the error details.
Represents information about an error/exception that occurred with an API call to Amazon Yojaka.
Status: 401 - Unauthorized. You are not authorized to invoke this API for the given parameters.
Represents information about an error/exception that occurred with an API call to Amazon Yojaka.
Status: 404 - Not found. The specified return id is not found.
Represents information about an error/exception that occurred with an API call to Amazon Yojaka.
Status: 500 - Internal server error. Contact Amazon support for assistance.
Represents information about an error/exception that occurred with an API call to Amazon Yojaka.
Status: 503 - Service unavailable. Retry the request after some time.
Represents information about an error/exception that occurred with an API call to Amazon Yojaka.