API Explorer

Custom Order

Create or update an order using raw XML or JSON requests

POST

Create a new order using a raw XML or JSON request.

https://nwframing.com:443/IFS/api/{role}/CustomOrder
(details)

Order

Read or write a single order's information with URL requests

GET

Get details on a single order

https://nwframing.com:443/IFS/api/{role}/Order/{id}
(details)

Order Body

Create or update an order using raw XML or JSON requests

POST

Create a new order using a raw XML or JSON request. All SKU’s must be setup in our system prior to being submitted with an order. If an order is submitted with a SKU that isn’t on your list of SKU’s then it won’t be imported into our system

https://nwframing.com:443/IFS/api/{role}/OrderBody
(details)
PUT

Update an order using a raw XML or JSON request

https://nwframing.com:443/IFS/api/{role}/OrderBody
(details)

Orders

Read or write multiple order information using URL requests.

GET

Get a summary of all order items with the specified criteria

https://nwframing.com:443/IFS/api/{role}/Orders?{params}
(details)

Orders Flat

Create or update orders using a flat request body

POST

Creates multiple orders using a flat (non-nested) request body. It is recommended to use the Order Body method if you prefer a structured request.

https://nwframing.com:443/IFS/api/{role}/OrdersFlat
(details)
PUT

Updates multiple orders using a flat (non-nested) request. It is recommended to use the Order Body method if you prefer a structured request.

https://nwframing.com:443/IFS/api/{role}/OrdersFlat
(details)

Order SKU

API Calls relating to an order's sku using URL requests

PUT

Update a SKU within your order using URL parameters. (Requries Special Permissions)

https://nwframing.com:443/IFS/api/{role}/OrderSKU/{id}?{params}
(details)

Order Status

Read or write the status of an order using URL requests. Also available via webhook

GET

Get the status for a specific order

https://nwframing.com:443/IFS/api/{role}/OrderStatus/{id}
(details)
PUT

Change the status of an order item

https://nwframing.com:443/IFS/api/{role}/OrderStatus/{id}?{params}
(details)

Package

Read package information

GET

Get a list of available package treatments

https://nwframing.com:443/IFS/api/{role}/Package
(details)

Shipping

Shipping API Endpoints

POST

Get a shipping quote

https://nwframing.com:443/IFS/api/{role}/shipping/quote
(details)

Web Artwork Inventory

API Calls relating to Artwork Inventory (requires special permissions)

GET

Find Artwork Inventory By Query (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebArtworkInventory?{params}
(details)
GET

Find artwork Inventory by Artwork ID (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebArtworkInventory/{id}
(details)

Web Artwork Transaction

API Calls relating to Artwork Transactions (requires special permissions)

GET

Find Artwork Transactions By Query (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebArtworkTransaction?{params}
(details)
GET

Find artwork transactions by Reference Number (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebArtworkTransaction/{id}
(details)

Web Material Inventory

API Calls relating to material inventory (requires special permissions)

GET

Find material inventory by query(requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebMaterialInventory?{params}
(details)

Web Material Transaction

API Calls relating to material transactions (requires special permissions)

GET

Find material transactions by Reference Number (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebMaterialTransaction/{id}
(details)
GET

Find material transactions by query (requires special permissions)

https://nwframing.com:443/IFS/api/{role}/WebMaterialTransaction?{params}
(details)