Nalpac API Documentation

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".

OrderStatus

View order status information

APIDescription
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.

Inventory

Get product inventory information.

APIDescription
GET api/inventory?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&locationId={locationId}

No documentation available.

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.

Carrier

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

APIDescription
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.

InventoryV2

APIDescription
GET api/inventoryV2?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}

No documentation available.

GET api/inventoryV2/{sku}

No documentation available.

GET api/inventoryV2?upc={upc}

No documentation available.

GET api/inventoryV2?manufacturerNumber={manufacturerNumber}

No documentation available.

GET api/inventoryV2?itemIdentifier={itemIdentifier}

No documentation available.

Order

Create new orders and view detailed order information.

APIDescription
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.

ProductV2

APIDescription
GET api/productV2?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&keyword={keyword}&manufacturer={manufacturer}&supplierId={supplierId}&excludeDiscontinued={excludeDiscontinued}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productV2/{sku}?stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productsV2?sku={sku}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productV2?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productsV2?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productV2?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productsV2?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}

No documentation available.

GET api/productV2/{sku}/price

No documentation available.

GET api/productV2/{sku}/image?size={size}&includeAlternates={includeAlternates}

No documentation available.

PackingSlip

APIDescription
GET api/packingsliptypes

No documentation available.

CategoryHierarchy

Explore the category hierarchy

APIDescription
GET api/categoryHierarchy

Get the root category node

GET api/categoryHierarchy/{id}

Get a category node by id

Product

Get detailed product information.

APIDescription
GET api/product?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&keyword={keyword}&manufacturer={manufacturer}&supplierId={supplierId}&excludeDiscontinued={excludeDiscontinued}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/product/{sku}?stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/products?sku={sku}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/product?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/products?upc={upc}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/product?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/products?manufacturerNumber={manufacturerNumber}&stripDescriptionHTML={stripDescriptionHTML}&locationId={locationId}

No documentation available.

GET api/product/{sku}/price

Get your discounted price for a product.

POST api/productsayhello

No documentation available.