items-api

name	Items API
description	Use when working with alternate code, assembly hdr, assembly line, attribute, attribute group, attribute group x attribute value, attribute value, attribute x attribute group, bin, brands, brands x items, categories, contracts items, data type context, health check, internal, inv accessory, inv adj hdr, inv bin, inv loc, inv loc stock status, inv mast, inv mast 15, inv mast attributes, inv mast context, inv mast external, inv mast faq, inv mast language, inv mast links, inv mast lot, inv mast msds, inv mast similarity hdr, inv mast similarity line, inv mast sub parts, inv mast ud, inv mast x restricted class, inv period usage, inv sub, inv xref, inventory receipts hdr, inventory supplier, inventory supplier x loc, item attribute value, item catalog, item catalog def, item catalog def detail, item category, item category hierarchy, item category hierarchy delete audit, item category image, item category link, item category meaning, item category text, item category ud, item category x inv mast, item conversion, item favorites, item meaning, item metrics, item package type, item price hash, item uom, item variant hdr, item variant hdr x attribute, item variant line, item wishlist hdr, item wishlist line, package type, promotional group det, promotional group hdr, refresh items log, seed, sync tracking hdr, sync tracking line, unit of measure, web display type, or making API calls to https://items.augur-api.com.
version	1.0.5

Items

Service-specific knowledge for items microservice.

API Documentation

• OpenAPI Specification
• Postman Collection

Authentication

All endpoints except /health-check and /ping require bearer token authentication. See authentication.md for details.

API Endpoints

alternate_code

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/alternate-code	List alternate codes	alternate_code.md

attribute

Method	Endpoint	Description	Details
GET	/attributes/{attributeUid}	Get Attribute Group Details	attribute.md
PUT	/attributes/{attributeUid}	Update Attribute	attribute.md
DELETE	/attributes/{attributeUid}	DELETE Attribute	attribute.md
GET	/attributes	List Attributes	attribute.md
POST	/attributes	Create Attribute	attribute.md

attribute_group

Method	Endpoint	Description	Details
GET	/attribute-groups/{attributeGroupUid}	Get Attribute Group Details	attribute_group.md
PUT	/attribute-groups/{attributeGroupUid}	Update Attribute Group	attribute_group.md
DELETE	/attribute-groups/{attributeGroupUid}	DELETE Attribute Group	attribute_group.md
GET	/attribute-groups	List Attribute Groups	attribute_group.md
POST	/attribute-groups	Create Attribute Group	attribute_group.md

attribute_value

Method	Endpoint	Description	Details
GET	/attributes/{attributeUid}/values/{attributeValueUid}	Get AttributeValue Details	attribute_value.md
PUT	/attributes/{attributeUid}/values/{attributeValueUid}	Update AttributeValue	attribute_value.md
DELETE	/attributes/{attributeUid}/values/{attributeValueUid}	DELETE AttributeValue	attribute_value.md
GET	/attributes/{attributeUid}/values	List AttributeValues	attribute_value.md
POST	/attributes/{attributeUid}/values	Create AttributeValue	attribute_value.md

attribute_x_attribute_group

Method	Endpoint	Description	Details
GET	/attribute-groups/{attributeGroupUid}/attributes/{attributeXAttributeGroupUid}	Get Attribute X Attribute Group Details	attribute_x_attribute_group.md
PUT	/attribute-groups/{attributeGroupUid}/attributes/{attributeXAttributeGroupUid}	Update Attribute X Attribute Group	attribute_x_attribute_group.md
DELETE	/attribute-groups/{attributeGroupUid}/attributes/{attributeXAttributeGroupUid}	DELETE Attribute X Attribute Group	attribute_x_attribute_group.md
GET	/attribute-groups/{attributeGroupUid}/attributes	List Attribute X Attribute Groups	attribute_x_attribute_group.md
POST	/attribute-groups/{attributeGroupUid}/attributes	Create Attribute X Attribute Group	attribute_x_attribute_group.md

brands

Method	Endpoint	Description	Details
GET	/brands/{brandsUid}/attributes	List attributes for brand items	brands.md
GET	/brands/{brandsUid}	Get Brands Details	brands.md
PUT	/brands/{brandsUid}	Update Brands	brands.md
DELETE	/brands/{brandsUid}	DELETE Brands	brands.md
GET	/brands	List Brands	brands.md
POST	/brands	Create Brands	brands.md
GET	/brands/{brandsUid}/items	List items for a brand	brands.md

categories

Method	Endpoint	Description	Details
GET	/categories/{itemCategoryUid}/attributes	list the attributes in a category	categories.md
GET	/categories/{itemCategoryUid}	Get the category details	categories.md
GET	/categories/{itemCategoryUid}/images	list the images for a category	categories.md
GET	/categories/{itemCategoryUid}/items	list the items in a category	categories.md
GET	/categories/lookup	lookup the categories details	categories.md

contracts_items

Method	Endpoint	Description	Details
GET	/contracts/{jobNo}/attributes	list the attributes for contract items	contracts_items.md
GET	/contracts/{jobNo}/items	List contracts items for a job	contracts_items.md

health_check

Method	Endpoint	Description	Details
GET	/health-check	Health Check	health_check.md
GET	/ping	Ping to get Pong	health_check.md
GET	/whoami	Whoami	health_check.md

internal

Method	Endpoint	Description	Details
POST	/internal/pdf	Generate PDF	internal.md

inv_accessory

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/inv-accessory	List accessory items	inv_accessory.md

inv_bin

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/locations/{locationId}/bins/{bin}	Get a specific bin for an inventory item at a specific location	inv_bin.md
GET	/inv-mast/{invMastUid}/locations/{locationId}/bins	List bins for a specific location	inv_bin.md
GET	/locations/{locationId}/bins/{bin}	List all items in a specific bin	inv_bin.md
GET	/locations/{locationId}/bins	List all items in bins at a location	inv_bin.md

inv_loc

Method	Endpoint	Description	Details
GET	/inv-loc	List InvLoc	inv_loc.md
GET	/inv-mast/{invMastUid}/stock	get the inv_mast stock	inv_loc.md

inv_mast

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}	get the inv_mast details	inv_mast.md
GET	/inv-mast/lookup	Lookup InvMast by search query	inv_mast.md
GET	/inv-mast	List InvMast	inv_mast.md
GET	/inv-mast/{invMastUid}/doc	get the inv_mast document	inv_mast.md
GET	/p21/inv-mast	List raw inv_mast P21 data	inv_mast.md

inv_mast_faq

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/faq/{invMastFaqUid}	Get Item FAQ Details	inv_mast_faq.md
PUT	/inv-mast/{invMastUid}/faq/{invMastFaqUid}	Update Item FAQ	inv_mast_faq.md
DELETE	/inv-mast/{invMastUid}/faq/{invMastFaqUid}	DELETE Item FAQ	inv_mast_faq.md
GET	/inv-mast/{invMastUid}/faq	List Item FAQs	inv_mast_faq.md
POST	/inv-mast/{invMastUid}/faq	Create Item FAQ	inv_mast_faq.md

inv_mast_links

Method	Endpoint	Description	Details
GET	/inv-mast-links/{invMastUid}	List document links for an item	inv_mast_links.md

inv_mast_similarity_hdr

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/similar	List similar items	inv_mast_similarity_hdr.md

inv_mast_sub_parts

Method	Endpoint	Description	Details
GET	/inv-mast-sub-parts/{invMastUid}	List sub parts for an item	inv_mast_sub_parts.md

inv_mast_ud

Method	Endpoint	Description	Details
GET	/inv-mast-ud	List inv_mast_ud records with filtering and pagination	inv_mast_ud.md

inv_sub

Method	Endpoint	Description	Details
GET	/inv-mast/{invMastUid}/inv-sub	List substitute items	inv_sub.md

item_attribute_value

Method	Endpoint	Description	Details
PUT	/inv-mast/{invMastUid}/attributes/{attributeUid}/values/{attributeValueUid}	Update the status of an attribute value	item_attribute_value.md
DELETE	/inv-mast/{invMastUid}/attributes/{attributeUid}/values/{attributeValueUid}	Soft delete an attribute value	item_attribute_value.md
GET	/inv-mast/{invMastUid}/attributes/{attributeUid}/values	List values for a specific item attribute	item_attribute_value.md
POST	/inv-mast/{invMastUid}/attributes/{attributeUid}/values	Create a new attribute value for an item using a specific attribute	item_attribute_value.md
GET	/inv-mast/{invMastUid}/attributes	List item attributes	item_attribute_value.md
POST	/inv-mast/{invMastUid}/attributes	Create a new attribute value for an item	item_attribute_value.md

item_category

Method	Endpoint	Description	Details
GET	/item-category/{itemCategoryUid}	get the item_category details	item_category.md
GET	/item-category/lookup	lookup the item_category details	item_category.md
GET	/item-category	list of categories	item_category.md
GET	/item-category/{itemCategoryUid}/doc	get the item_category document	item_category.md

item_favorites

Method	Endpoint	Description	Details
GET	/item-favorites/{usersId}/items	List the item favorites for a user	item_favorites.md
POST	/item-favorites/{usersId}/items	Create item favorites	item_favorites.md
GET	/item-favorites/{usersId}/items/{invMastUid}	Get a single item favorite	item_favorites.md
PUT	/item-favorites/{usersId}/items/{invMastUid}	Toggle an item favorite active/inactive	item_favorites.md
DELETE	/item-favorites/{usersId}/items/{invMastUid}	Soft Delete an item from a user's favorites	item_favorites.md

item_uom

Method	Endpoint	Description	Details
GET	/item-uom/{itemUomUid}	Get Item UOM Details	item_uom.md
GET	/item-uom	List Item UOMs	item_uom.md

item_variant_hdr

Method	Endpoint	Description	Details
GET	/variants/{itemVariantHdrUid}	Get Item Variant Header Details	item_variant_hdr.md
PUT	/variants/{itemVariantHdrUid}	Update Item Variant Header	item_variant_hdr.md
DELETE	/variants/{itemVariantHdrUid}	DELETE Item Variant Header	item_variant_hdr.md
GET	/variants/{itemVariantHdrUid}/doc	Get Variant Doc	item_variant_hdr.md
GET	/variants	List Item Variant Headers	item_variant_hdr.md
POST	/variants	Create Item Variant Header	item_variant_hdr.md
GET	/variants/{itemVariantHdrUid}/similar	Find Similar Items for Variant Header	item_variant_hdr.md

item_variant_hdr_x_attribute

Method	Endpoint	Description	Details
GET	/variants/{itemVariantHdrUid}/attributes/{attributeUid}	Get variant attribute link details	item_variant_hdr_x_attribute.md
PUT	/variants/{itemVariantHdrUid}/attributes/{attributeUid}	Update variant attribute link	item_variant_hdr_x_attribute.md
DELETE	/variants/{itemVariantHdrUid}/attributes/{attributeUid}	Remove attribute from variant	item_variant_hdr_x_attribute.md
GET	/variants/{itemVariantHdrUid}/attributes	List attributes for variant	item_variant_hdr_x_attribute.md
POST	/variants/{itemVariantHdrUid}/attributes	Add attribute to variant	item_variant_hdr_x_attribute.md

item_variant_line

Method	Endpoint	Description	Details
GET	/variants/{itemVariantHdrUid}/lines/{itemVariantLineUid}	Get Item Variant Line Details	item_variant_line.md
PUT	/variants/{itemVariantHdrUid}/lines/{itemVariantLineUid}	Update Item Variant Line	item_variant_line.md
DELETE	/variants/{itemVariantHdrUid}/lines/{itemVariantLineUid}	DELETE Item Variant Line	item_variant_line.md
GET	/variants/{itemVariantHdrUid}/lines	List Item Variant Lines	item_variant_line.md
POST	/variants/{itemVariantHdrUid}/lines	Create Item Variant Line	item_variant_line.md

item_wishlist_hdr

Method	Endpoint	Description	Details
GET	/item-wishlist/{usersId}	List the item wishlists for a user	item_wishlist_hdr.md
POST	/item-wishlist/{usersId}	Create a new item wishlist	item_wishlist_hdr.md
PUT	/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}	Update a new item wishlist	item_wishlist_hdr.md
DELETE	/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}	Delete an item wishlist	item_wishlist_hdr.md

item_wishlist_line

Method	Endpoint	Description	Details
GET	/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}	List items in a wishlist	item_wishlist_line.md
POST	/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}	Create one more more item in a wishlist	item_wishlist_line.md
DELETE	/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}/line/{itemWishlistLineUid}	Delete an item from a wishlist	item_wishlist_line.md