Skip to content

Latest commit

 

History

History
105 lines (83 loc) · 4.62 KB

OrderStatusApi.md

File metadata and controls

105 lines (83 loc) · 4.62 KB

xi.sdk.resellers.Api.OrderStatusApi

All URIs are relative to https://api.ingrammicro.com:443

Method HTTP request Description
ResellersV1WebhooksOrderstatuseventPost POST /resellers/v1/webhooks/orderstatusevent Order Status

ResellersV1WebhooksOrderstatuseventPost

void ResellersV1WebhooksOrderstatuseventPost (string targeturl, string xHubSignature, OrderStatusAsyncNotificationRequest orderStatusAsyncNotificationRequest)

Order Status

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;

namespace Example
{
    public class ResellersV1WebhooksOrderstatuseventPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.ingrammicro.com:443";
            // Configure OAuth2 access token for authorization: application
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new OrderStatusApi(httpClient, config, httpClientHandler);
            var targeturl = https://59a2dc5368073ab42fd9a92e210a9fdb.m.pipedream.net/;  // string | The webhook url where the request needs to sent.
            var xHubSignature = 3LeaTfLE5FLj1FcYflwdwFosH4ADHmMbds6thtirGC3e9lEkF9/1pt4T2fQQGlxf40EznDBER0b60M75K6ZW0A==;  // string | Ingram Micro creates a signature token by use of a secret key + Event ID. The algorithm to generate the secret ley is given at link https://developer.ingrammicro.com/reseller/article/how-use-webhook-secret-key. Use the event Id in the below sample along with your secret key to generate the key. Alternatively, to send try this out, use a random text to see how it works.
            var orderStatusAsyncNotificationRequest = new OrderStatusAsyncNotificationRequest(); // OrderStatusAsyncNotificationRequest | 

            try
            {
                // Order Status
                apiInstance.ResellersV1WebhooksOrderstatuseventPost(targeturl, xHubSignature, orderStatusAsyncNotificationRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OrderStatusApi.ResellersV1WebhooksOrderstatuseventPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ResellersV1WebhooksOrderstatuseventPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Order Status
    apiInstance.ResellersV1WebhooksOrderstatuseventPostWithHttpInfo(targeturl, xHubSignature, orderStatusAsyncNotificationRequest);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OrderStatusApi.ResellersV1WebhooksOrderstatuseventPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
targeturl string The webhook url where the request needs to sent.
xHubSignature string Ingram Micro creates a signature token by use of a secret key + Event ID. The algorithm to generate the secret ley is given at link https://developer.ingrammicro.com/reseller/article/how-use-webhook-secret-key. Use the event Id in the below sample along with your secret key to generate the key. Alternatively, to send try this out, use a random text to see how it works.
orderStatusAsyncNotificationRequest OrderStatusAsyncNotificationRequest

Return type

void (empty response body)

Authorization

application

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
500 Internal Server Error -

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