Nalpac Connect - Nalpac API Documentation

Introduction

This is a REST API that can create orders and get product, inventory, carrier, order and order status data.

Example Code

Examples of how to use the API in different programming languages:

XML or JSON

You can choose to use XML or JSON data. To send XML or JSON, add a "Content-Type" http header set to either "application/xml" or "application/json". To receive XML or JSON, add an "Accept" http header set to either "application/xml" or "application/json".

Product

Get detailed product information.

API	Description
GET api/product?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&keyword={keyword}&manufacturer={manufacturer}&excludeDiscontinued={excludeDiscontinued}&stripDescriptionHTML={stripDescriptionHTML}	Get detailed product information for items found withing the specified parameters.
GET api/product/{sku}?stripDescriptionHTML={stripDescriptionHTML}	Get detailed product information for a specified sku.
GET api/products?sku={sku}&stripDescriptionHTML={stripDescriptionHTML}	No documentation available.
GET api/product?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}	Get detailed product information for a specified upc.
GET api/products?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}	No documentation available.
GET api/product?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}	Get detailed product information for a specified manufacturer number.
GET api/products?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}	No documentation available.
GET api/product/{sku}/price	Get your discounted price for a product.
GET api/product/{sku}/image?size={size}&includeAlternates={includeAlternates}	No documentation available.

PackingSlip

API	Description
GET api/packingsliptypes	No documentation available.

CategoryHierarchy

Explore the category hierarchy

API	Description
GET api/categoryHierarchy	Get the root category node
GET api/categoryHierarchy/{id}	Get a category node by id

Carrier

Get available carriers. A Carrier Id is required to create an order.

API	Description
GET api/carrier	Get a list of all available carriers and their shipping options. An id of a shipping option is required to create an order.
GET api/carrier?destinationCountry={destinationCountry}&destinationState={destinationState}&destinationZip={destinationZip}&weight={weight}&length={length}&width={width}&height={height}	Get a list of carriers and their rates for their shipping options. If the rate is null it means that we were unable to calculate it with the paramters provided.
GET api/Carrier/{id}	Get a specific carrier by id.

Inventory

Get product inventory information.

API	Description
GET api/inventory?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}	Get inventory details for items found within the specified parameters.
GET api/inventory/{sku}	Get inventory details for a specified sku.
GET api/inventory?upc={upc}	Get inventory details for a specified upc.
GET api/inventory?manufacturerNumber={manufacturerNumber}	Get inventory details for a specified manufacturer number.
GET api/inventory?itemIdentifier={itemIdentifier}	Get inventory details for a specified item identifier. First checks the product's Sku then UPC then Manufacturer Number.

Order

Create new orders and view detailed order information.

API	Description
GET api/order?pageNumber={pageNumber}&orderedBefore={orderedBefore}&orderedAfter={orderedAfter}&shippedBefore={shippedBefore}&shippedAfter={shippedAfter}&shipToName={shipToName}&sortBy={sortBy}&poNumber={poNumber}&externalOrderNumber={externalOrderNumber}&trackingNumber={trackingNumber}&orderNumber={orderNumber}	No documentation available.
GET api/order?pageNumber={pageNumber}&orderedBefore={orderedBefore}&orderedAfter={orderedAfter}&shippedBefore={shippedBefore}&shippedAfter={shippedAfter}&shipToName={shipToName}&sortBy={sortBy}	No documentation available.
GET api/order/{orderNumber}	Get order details for the specified order number.
GET api/order/shipped?pageNumber={pageNumber}&pageSize={pageSize}	No documentation available.
GET api/order/queued?pageNumber={pageNumber}&pageSize={pageSize}	No documentation available.
GET api/order/nonimported?pageNumber={pageNumber}&pageSize={pageSize}	No documentation available.
GET api/order?externalOrderNumber={externalOrderNumber}	Get order details for the specified external order number.
GET api/order?poNumber={poNumber}	Get order details for the specified po number.
GET api/order?trackingNumber={trackingNumber}	Get order details for the specified tracking number.
POST api/order	Create a new order.

OrderStatus

View order status information

API	Description
GET api/orderstatus?pageNumber={pageNumber}&pageSize={pageSize}&orderedBefore={orderedBefore}&orderedAfter={orderedAfter}&shippedBefore={shippedBefore}&shippedAfter={shippedAfter}&shipToName={shipToName}	Get order status for all orders placed during the specified date range.
GET api/orderstatus/{orderNumber}	Get order status for a specific order number
GET api/orderstatus?externalOrderNumber={externalOrderNumber}	Get order status for a specific external order number
GET api/orderstatus?poNumber={poNumber}	Get order status for a specific po number
GET api/orderstatus?trackingNumber={trackingNumber}	Get order status for a specific tracking number.