ASP.NET Web API Help Page

Introduction

This service is intended for use by Promega's employees and authorized services. Methods requiring authentication will be marked with "Requires Authentication".

The methods below can be used to retrieve data.

Business Object Model

Addresses

A set of actions to manage addresses

API	Description
PUT api/addresses/{sapCustomerType}/{parentId}	Update an address
PATCH api/addresses/{sapCustomerType}/{parentId}	Update an address
POST api/addresses/{sapCustomerType}/{parentId}	Add an address
GET api/addresses/{sapCustomerType}/{parentId}/{id}	Get an address
DELETE api/addresses/{sapCustomerType}/{parentId}/{id}	Delete an address

CreditCards

A set of actions to manage credit cards

API	Description
PUT api/creditCards/{sapCustomerType}/{parentId}	Update a creditCard
PATCH api/creditCards/{sapCustomerType}/{parentId}	Update a creditCard
POST api/creditCards/{sapCustomerType}/{parentId}	Add an creditCard
GET api/creditCards/{sapCustomerType}/{parentId}/{id}	Get a creditCard
DELETE api/creditCards/{sapCustomerType}/{parentId}/{id}	Delete a creditCard

Customers

A set of actions to manage customers

API	Description
GET api/customers/{id}?childObjects={childObjects}	Get a customer by Id
GET api/customers?childObjects={childObjects}	Get the currently authenticated customer
POST api/customers?childObjects={childObjects}	Add a customer
PUT api/customers?updateLoginInfoOnly={updateLoginInfoOnly}	Update a customer
PATCH api/customers?updateLoginInfoOnly={updateLoginInfoOnly}	Update a customer
GET api/customers?userName={userName}&childObjects={childObjects}	Get a customer by username

DoorUnlocks

A set of actions to unlock Helix units

API	Description
GET api/doorUnlocks/{unitId}/{passId}?paymentMethodId={paymentMethodId}	Returns OK if a door unlock request was sent to Jetstream

Favorites

A set of actions for institutes

API	Description
GET api/favorites/{customerId}/{salesOrganizationId}	Returns a customer's favorites
PUT api/favorites/{customerId}/{salesOrganizationId}	Update favorites
PATCH api/favorites/{customerId}/{salesOrganizationId}	Update favorites

FreightChargeOptions

A set of actions to return freight options

API	Description
POST api/freightChargeOptions?childObjects={childObjects}

ImpersonationLogin

Impersonation Login Controller

API	Description
GET api/ImpersonationCallback?code={code}	Authorization Code Callback
GET api/ImpersonationLogin	Get
GET api/ImpersonationLogin?loginPrompt={loginPrompt}	Get Login Redirect
GET api/ImpersonationLogout?token={token}	Get with a logout option

Institutes

A set of actions for institutes

API	Description
GET api/institutes	Get all institutes
GET api/institutes/{id}?childObjects={childObjects}	Returns an institute
POST api/institutes?childObjects={childObjects}	Search institutes

InternalReferenceNumbers

A set of actions for internal reference number payment methods

API	Description
PUT api/internalReferenceNumbers/{sapCustomerType}/{parentId}	Update an internalReferenceNumberPaymentMethod
PATCH api/internalReferenceNumbers/{sapCustomerType}/{parentId}	Update an internalReferenceNumberPaymentMethod
POST api/internalReferenceNumbers/{sapCustomerType}/{parentId}	Add an internalReferenceNumberPaymentMethod
GET api/internalReferenceNumbers/{sapCustomerType}/{parentId}/{id}	Get an internalReferenceNumberPaymentMethod
DELETE api/internalReferenceNumbers/{sapCustomerType}/{parentId}/{id}	Delete an internalReferenceNumberPaymentMethod by Id

MailingAddresses

A set of actions to manage addresses

API	Description
GET api/mailingaddresses/{customerId}	Get the mailing of the customer identified by the customerId
PUT api/mailingaddresses/{customerId}	Update a mailing address
PATCH api/mailingaddresses/{customerId}	Update a mailing address

OrderHistoryItems

A set of actions to return sales orders

API	Description
POST api/orderHistoryItems?page={page}&pageSize={pageSize}&sortField={sortField}&sortOrder={sortOrder}	Get order history items

Partnerships

A set of actions for partnerships

API	Description
GET api/partnerships	Get all partnerships
GET api/partnerships/{id}?childObjects={childObjects}	Returns a partnership
PUT api/partnerships?childObjects={childObjects}	Update a partnership
PATCH api/partnerships?childObjects={childObjects}	Update a partnership

Passes

A set of actions to manage passes

API	Description
GET api/passes/{id}?childObjects={childObjects}	Get a pass
DELETE api/passes/{sapCustomerType}/{parentId}/{id}	Delete a pass
PUT api/passes/{sapCustomerType}/{parentId}?childObjects={childObjects}	Update a pass
PATCH api/passes/{sapCustomerType}/{parentId}?childObjects={childObjects}	Update a pass
POST api/passes/{sapCustomerType}/{parentId}?childObjects={childObjects}	Add a pass

PppOrderHistoryItems

A set of actions to get PPP order history items

API	Description
POST api/pppOrderHistoryItems?removePendingOrders={removePendingOrders}&page={page}&pageSize={pageSize}&sortField={sortField}&sortOrder={sortOrder}	Get Ppp order history items

Prices

A set of actions to return prices

API	Description
POST api/prices?sapCountry={sapCountry}&sort={sort}&childObjects={childObjects}&customerId={customerId}&organizationId={organizationId}&soldToId={soldToId}&unitId={unitId}&performInventoryCheck={performInventoryCheck}&priceEffectiveDate={priceEffectiveDate}&customerGroup2={customerGroup2}&getOffLineListPrice={getOffLineListPrice}&orderSource={orderSource}&pricingCustomer={pricingCustomer}&websiteMaterialsOnly={websiteMaterialsOnly}	Get Prices using the SAP CustomerId, Version 2

API

Description

POST api/prices?sapCountry={sapCountry}&sort={sort}&childObjects={childObjects}&customerId={customerId}&organizationId={organizationId}&soldToId={soldToId}&unitId={unitId}&performInventoryCheck={performInventoryCheck}&priceEffectiveDate={priceEffectiveDate}&customerGroup2={customerGroup2}&getOffLineListPrice={getOffLineListPrice}&orderSource={orderSource}&pricingCustomer={pricingCustomer}&websiteMaterialsOnly={websiteMaterialsOnly}

Get Prices using the SAP CustomerId, Version 2

ProductPages

A set of actions to return product pages

API	Description
GET api/productPages?filter={filter}&page={page}&pageSize={pageSize}&childObjects={childObjects}	Get Sitecore product pages based on the search criteria. Results are paged.

Products

A set of actions to return products

API	Description
GET api/products/{id}?childObjects={childObjects}	Returns a product by Material Number
GET api/products?filter={filter}&page={page}&pageSize={pageSize}&sort={sort}&childObjects={childObjects}&passId={passId}&unitId={unitId}&siteId={siteId}&onlyHelixQualified={onlyHelixQualified}&excludedProductPrefixesSemiColonDelimited={excludedProductPrefixesSemiColonDelimited}&searchAllSitesAndWholeCatalog={searchAllSitesAndWholeCatalog}	Get products based on the filter criteria in pages
POST api/products?sapCountry={sapCountry}&sort={sort}&childObjects={childObjects}&customerId={customerId}&organizationId={organizationId}&unitId={unitId}&priceEffectiveDate={priceEffectiveDate}&soldToId={soldToId}	Returns product details for a collection of Material Numbers

PurchaseOrders

A set of actions to manage purchase orders

API	Description
PUT api/purchaseOrders/{sapCustomerType}/{parentId}	Update a Purchase Order
PATCH api/purchaseOrders/{sapCustomerType}/{parentId}	Update a Purchase Order
POST api/purchaseOrders/{sapCustomerType}/{parentId}	Add an purchaseOrder
GET api/purchaseOrders/{sapCustomerType}/{parentId}/{id}	Get an purchaseOrder by Id
DELETE api/purchaseOrders/{sapCustomerType}/{parentId}/{id}	Delete an purchaseOrder by Id

Quotes

A set of actions for institutes

API	Description
POST api/quotes?childObjects={childObjects}	Create Quote
DELETE api/quotes?quoteNumber={quoteNumber}	Cancel Quote

SalesDocuments

A set of actions to manage sales documents

API	Description
POST api/salesDocuments?childObjects={childObjects}	Create Sales Document

SalesOrders

A set of actions to return sites

API	Description
POST api/salesOrders	Add a sales order
GET api/salesOrders/{orderNumber}?childObjects={childObjects}	Returns a sales order
PUT api/salesOrders?childObjects={childObjects}	Update a sales order
PATCH api/salesOrders?childObjects={childObjects}	Update a sales order
GET api/salesOrders?orderNumbers[0]={orderNumbers[0]}&orderNumbers[1]={orderNumbers[1]}&childObjects={childObjects}	Returns a sales order

Settings

Settings Controller

API	Description
GET api/settings/{sapCountry}?settingNames={settingNames}	Returns settings for the provided SAP country
GET api/settings?settingNames={settingNames}	Returns settings for the logged in customer

SimulatedOrders

A set of actions to manage simulated orders

API	Description
DELETE api/simulatedOrders/{customerId}/{salesOrganizationId}	Delete a simulated order
GET api/simulatedOrders/{customerId}/{salesOrganizationId}?childObjects={childObjects}&validateAndReprice={validateAndReprice}	Get Simulated Order (SAP cart) by customer id and SalesOrganization
POST api/simulatedOrders?childObjects={childObjects}	Add a simulated order

SimulatedSalesDocuments

A set of actions to manage simulated sales documents

API	Description
POST api/simulatedSalesDocuments?childObjects={childObjects}	Get Simulated Sales Document (a priced container in SAP)

Sites

A set of actions to return sites

API	Description
GET api/sites	Get all sites
GET api/sites/{id}?childObjects={childObjects}	Get a site
POST api/sites/{salesOrganizationId}?childObjects={childObjects}	Get filtered sites

UnitMaps

A set of actions to return units

API	Description
GET api/unitMaps/{id}	Returns a unit by Id

Units

A set of actions to return units

API	Description
GET api/units	Get all units
GET api/units/{id}?productPage={productPage}&productPageSize={productPageSize}&childObjects={childObjects}&soldToId={soldToId}&passId={passId}&productSort={productSort}&organizationId={organizationId}&customerGroup2={customerGroup2}&getOffLineListPrice={getOffLineListPrice}&automaticPriceRetrieval={automaticPriceRetrieval}	Returns a unit by Id
POST api/units/{salesOrganizationId}?childObjects={childObjects}	Get filtered units

VatRegistrationNumberValidations

A set of actions for VAT

API	Description
GET api/vatRegistrationNumberValidations/{countryCode}/{vatRegistrationNumber}	Get a validation for a VAT registration number

VersionChecks

Checks versions of clients supported

API	Description
GET api/versionchecks/{clientId}/{version}	Version Checks