Skip to content
BranchesTags

Latest commit

 

History

144 Commits

Folders and files

NameName
Last commit message
Last commit date
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
api
api
 
 
assets/images
assets/images
 
 
docs
docs
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
api_accesstoken.go
api_accesstoken.go
 
 
api_deals.go
api_deals.go
 
 
api_freight_estimate.go
api_freight_estimate.go
 
 
api_invoices.go
api_invoices.go
 
 
api_order_status.go
api_order_status.go
 
 
api_orders.go
api_orders.go
 
 
api_product_catalog.go
api_product_catalog.go
 
 
api_quotes.go
api_quotes.go
 
 
api_renewals.go
api_renewals.go
 
 
api_returns.go
api_returns.go
 
 
api_stock_update.go
api_stock_update.go
 
 
client.go
client.go
 
 
configuration.go
configuration.go
 
 
getting-started.md
getting-started.md
 
 
git_push.sh
git_push.sh
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
model_accesstoken_response.go
model_accesstoken_response.go
 
 
model_availability_async_notification_request.go
model_availability_async_notification_request.go
 
 
model_availability_async_notification_request_resource_inner.go
model_availability_async_notification_request_resource_inner.go
 
 
model_availability_async_notification_request_resource_inner_links_inner.go
model_availability_async_notification_request_resource_inner_links_inner.go
 
 
model_deals_details_response.go
model_deals_details_response.go
 
 
model_deals_details_response_products_inner.go
model_deals_details_response_products_inner.go
 
 
model_deals_search_response.go
model_deals_search_response.go
 
 
model_deals_search_response_deals_inner.go
model_deals_search_response_deals_inner.go
 
 
model_error.go
model_error.go
 
 
model_error_response.go
model_error_response.go
 
 
model_error_response_dto.go
model_error_response_dto.go
 
 
model_error_response_errors_inner.go
model_error_response_errors_inner.go
 
 
model_error_response_errors_inner_fields_inner.go
model_error_response_errors_inner_fields_inner.go
 
 
model_fields.go
model_fields.go
 
 
model_freight_request.go
model_freight_request.go
 
 
model_freight_request_lines_inner.go
model_freight_request_lines_inner.go
 
 
model_freight_request_ship_to_address.go
model_freight_request_ship_to_address.go
 
 
model_freight_response.go
model_freight_response.go
 
 
model_freight_response_freight_estimate_response.go
model_freight_response_freight_estimate_response.go
 
 
model_freight_response_freight_estimate_response_distribution_inner.go
model_freight_response_freight_estimate_response_distribution_inner.go
 
 
model_freight_response_freight_estimate_response_distribution_inner_carrier_list_inner.go
model_freight_response_freight_estimate_response_distribution_inner_carrier_list_inner.go
 
 
model_freight_response_freight_estimate_response_lines_inner.go
model_freight_response_freight_estimate_response_lines_inner.go
 
 
model_get_accesstoken_400_response.go
model_get_accesstoken_400_response.go
 
 
model_get_accesstoken_500_response.go
model_get_accesstoken_500_response.go
 
 
model_get_accesstoken_500_response_fault.go
model_get_accesstoken_500_response_fault.go
 
 
model_get_accesstoken_500_response_fault_detail.go
model_get_accesstoken_500_response_fault_detail.go
 
 
model_get_reseller_v6_validate_quote_400_response.go
model_get_reseller_v6_validate_quote_400_response.go
 
 
model_get_reseller_v6_validate_quote_400_response_fields_inner.go
model_get_reseller_v6_validate_quote_400_response_fields_inner.go
 
 
model_invoice_detailsv6_1_response.go
model_invoice_detailsv6_1_response.go
 
 
model_invoice_detailsv6_1_response_bill_to_info.go
model_invoice_detailsv6_1_response_bill_to_info.go
 
 
model_invoice_detailsv6_1_response_fx_rate_info.go
model_invoice_detailsv6_1_response_fx_rate_info.go
 
 
model_invoice_detailsv6_1_response_lines_inner.go
model_invoice_detailsv6_1_response_lines_inner.go
 
 
model_invoice_detailsv6_1_response_lines_inner_serial_numbers_inner.go
model_invoice_detailsv6_1_response_lines_inner_serial_numbers_inner.go
 
 
model_invoice_detailsv6_1_response_payment_terms_info.go
model_invoice_detailsv6_1_response_payment_terms_info.go
 
 
model_invoice_detailsv6_1_response_ship_to_info.go
model_invoice_detailsv6_1_response_ship_to_info.go
 
 
model_invoice_detailsv6_1_response_summary.go
model_invoice_detailsv6_1_response_summary.go
 
 
model_invoice_detailsv6_1_response_summary_foreign_fx_totals.go
model_invoice_detailsv6_1_response_summary_foreign_fx_totals.go
 
 
model_invoice_detailsv6_1_response_summary_lines.go
model_invoice_detailsv6_1_response_summary_lines.go
 
 
model_invoice_detailsv6_1_response_summary_misc_charges_inner.go
model_invoice_detailsv6_1_response_summary_misc_charges_inner.go
 
 
model_invoice_detailsv6_1_response_summary_totals.go
model_invoice_detailsv6_1_response_summary_totals.go
 
 
model_invoice_search_response.go
model_invoice_search_response.go
 
 
model_invoice_search_response_invoices_inner.go
model_invoice_search_response_invoices_inner.go
 
 
model_order_create_request.go
model_order_create_request.go
 
 
model_order_create_request_additional_attributes_inner.go
model_order_create_request_additional_attributes_inner.go
 
 
model_order_create_request_end_user_info.go
model_order_create_request_end_user_info.go
 
 
model_order_create_request_lines_inner.go
model_order_create_request_lines_inner.go
 
 
model_order_create_request_lines_inner_additional_attributes_inner.go
model_order_create_request_lines_inner_additional_attributes_inner.go
 
 
model_order_create_request_lines_inner_end_user_info_inner.go
model_order_create_request_lines_inner_end_user_info_inner.go
 
 
model_order_create_request_lines_inner_warranty_info_inner.go
model_order_create_request_lines_inner_warranty_info_inner.go
 
 
model_order_create_request_lines_inner_warranty_info_inner_serial_info_inner.go
model_order_create_request_lines_inner_warranty_info_inner_serial_info_inner.go
 
 
model_order_create_request_reseller_info.go
model_order_create_request_reseller_info.go
 
 
model_order_create_request_ship_to_info.go
model_order_create_request_ship_to_info.go
 
 
model_order_create_request_shipment_details.go
model_order_create_request_shipment_details.go
 
 
model_order_create_request_vmf.go
model_order_create_request_vmf.go
 
 
model_order_create_response.go
model_order_create_response.go
 
 
model_order_create_response_end_user_info.go
model_order_create_response_end_user_info.go
 
 
model_order_create_response_orders_inner.go
model_order_create_response_orders_inner.go
 
 
model_order_create_response_orders_inner_additional_attributes_inner.go
model_order_create_response_orders_inner_additional_attributes_inner.go
 
 
model_order_create_response_orders_inner_lines_inner.go
model_order_create_response_orders_inner_lines_inner.go
 
 
model_order_create_response_orders_inner_lines_inner_additional_attributes_inner.go
model_order_create_response_orders_inner_lines_inner_additional_attributes_inner.go
 
 
model_order_create_response_orders_inner_lines_inner_shipment_details_inner.go
model_order_create_response_orders_inner_lines_inner_shipment_details_inner.go
 
 
model_order_create_response_orders_inner_links_inner.go
model_order_create_response_orders_inner_links_inner.go
 
 
model_order_create_response_orders_inner_miscellaneous_charges_inner.go
model_order_create_response_orders_inner_miscellaneous_charges_inner.go
 
 
model_order_create_response_orders_inner_rejected_line_items_inner.go
model_order_create_response_orders_inner_rejected_line_items_inner.go
 
 
model_order_create_response_ship_to_info.go
model_order_create_response_ship_to_info.go
 
 
model_order_create_v7_request.go
model_order_create_v7_request.go
 
 
model_order_create_v7_request_additional_attributes_inner.go
model_order_create_v7_request_additional_attributes_inner.go
 
 
model_order_create_v7_request_end_user_info.go
model_order_create_v7_request_end_user_info.go
 
 
model_order_create_v7_request_lines_inner.go
model_order_create_v7_request_lines_inner.go
 
 
model_order_create_v7_request_lines_inner_additional_attributes_inner.go
model_order_create_v7_request_lines_inner_additional_attributes_inner.go
 
 
model_order_create_v7_request_lines_inner_end_user_info_inner.go
model_order_create_v7_request_lines_inner_end_user_info_inner.go
 
 
model_order_create_v7_request_lines_inner_vmf_additional_attributes_lines_inner.go
model_order_create_v7_request_lines_inner_vmf_additional_attributes_lines_inner.go
 
 

Repository files navigation

Go API client for xi_sdk_resellers

For resellers seeking to innovate with Ingram Micro's API solutions, automate your eCommerce experience with our array of API's and webhooks to craft a seamless journey for your customers.

Installation

To install the package use:

go get -u github.com/ingrammicro-xvantage/xi-sdk-resellers-go

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import xi_sdk_resellers "github.com/ingrammicro-xvantage/xi-sdk-resellers-go"

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value xi_sdk_resellers.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), xi_sdk_resellers.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value xi_sdk_resellers.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), xi_sdk_resellers.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using xi_sdk_resellers.ContextOperationServerIndices and xi_sdk_resellers.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), xi_sdk_resellers.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), xi_sdk_resellers.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Getting Started

Quickstart on creating an application can be found here

Documentation for API Endpoints

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

Class Method HTTP request Description
AccesstokenAPI GetAccesstoken Get /oauth/oauth20/token Accesstoken
DealsAPI GetResellersV6Dealsdetails Get /resellers/v6/deals/{dealId} Deals Details
DealsAPI GetResellersV6Dealssearch Get /resellers/v6/deals/search Deals Search
FreightEstimateAPI PostFreightestimate Post /resellers/v6/freightestimate Freight Estimate
InvoicesAPI GetInvoicedetailsV61 Get /resellers/v6.1/invoices/{invoiceNumber} Get Invoice Details v6.1
InvoicesAPI GetResellersV6Invoicesearch Get /resellers/v6/invoices Search your invoice
OrderStatusAPI ResellersV1WebhooksOrderstatuseventPost Post /resellers/v1/webhooks/orderstatusevent Order Status
OrdersAPI DeleteOrdercancel Delete /resellers/v6/orders/{OrderNumber} Cancel your Order
OrdersAPI GetOrderdetailsV61 Get /resellers/v6.1/orders/{ordernumber} Get Order Details v6.1
OrdersAPI GetResellersV6Ordersearch Get /resellers/v6/orders/search Search your Orders
OrdersAPI PostCreateorderV6 Post /resellers/v6/orders Create your Order
OrdersAPI PostCreateorderV7 Post /resellers/v7/orders Create your Order v7
OrdersAPI PutOrdermodify Put /resellers/v6/orders/{orderNumber} Modify your Order
OrdersAPI VendorRequiredInfo Post /resellers/v7/vendorrequiredinfo Vendor Required Info
ProductCatalogAPI GetResellerV6Productdetail Get /resellers/v6/catalog/details/{ingramPartNumber} Product Details
ProductCatalogAPI GetResellerV6Productdetailcmp Get /resellers/v6/catalog/details Product Details
ProductCatalogAPI GetResellerV6Productsearch Get /resellers/v6/catalog Search Products
ProductCatalogAPI PostPriceandavailability Post /resellers/v6/catalog/priceandavailability Price and Availability
QuotesAPI GetQuotessearchV6 Get /resellers/v6/quotes/search Quote Search
QuotesAPI GetResellerV6ValidateQuote Get /resellers/v6/q2o/validatequote Validate Quote
QuotesAPI GetResellersV6Quotes Get /resellers/v6/quotes/{quoteNumber} Get Quote Details
RenewalsAPI GetResellersV6Renewalsdetails Get /resellers/v6/renewals/{renewalId} Renewals Details
RenewalsAPI PostRenewalssearch Post /resellers/v6/renewals/search Renewals Search
ReturnsAPI GetResellersV6Returnsdetails Get /resellers/v6/returns/{caseRequestNumber} Returns Details
ReturnsAPI GetResellersV6Returnssearch Get /resellers/v6/returns/search Returns Search
ReturnsAPI PostReturnscreate Post /resellers/v6/returns/create Returns Create
StockUpdateAPI ResellersV1WebhooksAvailabilityupdatePost Post /resellers/v1/webhooks/availabilityupdate Stock Update

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

application

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • write: allows modifying resources
  • read: allows reading resources
  • description:

Example

auth := context.WithValue(context.Background(), xi_sdk_resellers.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, xi_sdk_resellers.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Documentation For Authorization

Authentication schemes defined for the API:

application

Author

-Ingram Micro Xvantage

Contact

For any inquiries or support, please feel free to contact us at:

About

Ingram Micro - Xvantage Integration GO Server-side SDK

Topics

goingrammicrosdkxixvantage

Resources

Readme
MIT license
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

Packages

Used by

Contributors

Languages