Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 3.54 KB

ProductTracingApi.md

File metadata and controls

81 lines (62 loc) · 3.54 KB

DigiKey.Api.Api.ProductTracingApi

All URIs are relative to https://api.digikey.com/ProductTracing/v1

Method HTTP request Description
Details GET /Details/{tracingId} Retrieve detailed information about the product being traced

Details

ProductTracingResponse Details (string tracingId, string authorization, string xDIGIKEYClientId, string xDIGIKEYCustomerId = null)

Retrieve detailed information about the product being traced

Example

using System;
using System.Diagnostics;
using DigiKey.Api.Api;
using DigiKey.Api.Client;
using DigiKey.Api.Model;

namespace Example
{
    public class DetailsExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeySecurity
            Configuration.Default.AddApiKey("X-DIGIKEY-Client-Id", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-DIGIKEY-Client-Id", "Bearer");
            // Configure OAuth2 access token for authorization: oauth2AccessCodeSecurity
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductTracingApi();
            var tracingId = tracingId_example;  // string | The tracing Id of the product being traced
            var authorization = authorization_example;  // string | OAuth Bearer Token. Please see<a href= \"https://developer.digikey.com/documentation/oauth\" target= \"_blank\" > OAuth 2.0 Documentation </a > page for more info.
            var xDIGIKEYClientId = xDIGIKEYClientId_example;  // string | The Client Id for your App.
            var xDIGIKEYCustomerId = xDIGIKEYCustomerId_example;  // string | Your Digi-Key Customer id. If your account has multiple Customer Ids for different regions, this allows you to select one of them. (optional) 

            try
            {
                // Retrieve detailed information about the product being traced
                ProductTracingResponse result = apiInstance.Details(tracingId, authorization, xDIGIKEYClientId, xDIGIKEYCustomerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductTracingApi.Details: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
tracingId string The tracing Id of the product being traced
authorization string OAuth Bearer Token. Please see<a href= &quot;https://developer.digikey.com/documentation/oauth\" target= &quot;_blank&quot; > OAuth 2.0 Documentation </a > page for more info.
xDIGIKEYClientId string The Client Id for your App.
xDIGIKEYCustomerId string Your Digi-Key Customer id. If your account has multiple Customer Ids for different regions, this allows you to select one of them. [optional]

Return type

ProductTracingResponse

Authorization

apiKeySecurity, oauth2AccessCodeSecurity

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]