Attention: Our API is in active development. Please ensure to read our Development Notice for important information on potential changes and updates. We appreciate your understanding.

TBInt Products API tbint.io/products

The Products API facilitates seamless interaction with the item-related data in SAP systems. With the ability to fetch detailed information about individual products and their related attributes.

Table of contents

Mutations

Input Objects

Enums

Queries

Name
item
Type
query
Description

Returns a Items object

Arguments
  • Name
    color
    Type
    string
    Constraint
    required
    Description

    Color code of item

  • Name
    model
    Type
    string
    Constraint
    required
    Description

    Model of item

Name
items
Type
query
Description

Returns a list of Items

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Name
itemWithPrices
Type
query
Description

Returns a ItemWithPrices object

Arguments
  • Name
    color
    Type
    string
    Constraint
    required
    Description

    Color code of item

  • Name
    model
    Type
    string
    Constraint
    required
    Description

    Model of item

Name
itemWithSpecialPrices
Type
query
Description

Returns a ItemWithPrices object

Arguments
  • Name
    color
    Type
    string
    Constraint
    required
    Description

    Color code of item

  • Name
    model
    Type
    string
    Constraint
    required
    Description

    Model of item

Name
itemsWithPrices
Type
query
Description

Returns a list of ItemWithPrices

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Name
itemsWithSpecialPrices
Type
query
Description

Returns a list of ItemWithSpecialPrices

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Name
priceList
Type
query
Description

Returns a list of ItemWithPrices

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Name
periodDiscount
Type
query
Description

Returns a list of ItemWithSpecialPrices

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Name
deliveryNotes
Type
query
Description

Returns a list of DeliveryNotes

Arguments
  • Name
    salesChannel
    Type
    string
    Constraint
    required
    Description

    Name of sales channel

  • Name
    sortBy
    Type
    string
    Constraint
    Description

    Name of field in Order object by which to sort by

  • Name
    sortOrder
    Type
    Order
    Constraint
    Description

    Sorting order

  • Name
    searchInput
    Type
    string
    Constraint
    Description

    Search input value

  • Name
    page
    Type
    number
    Constraint
    Description

    Value of page from paginated results

  • Name
    take
    Type
    number
    Constraint
    Description

    Limit the number of rows returned by the query. Maximum value allowed: 1000

Objects

Name
Items
Type
object
Description

Represents information about an item.

Fields
  • Name
    ItemCode
    Type
    string
    Constraint
    Description

    Identifier for an item. Structure: Model-Color-Size

  • Name
    Model
    Type
    string
    Constraint
    Description

    Item's model

  • Name
    Barcode
    Type
    string
    Constraint
    Description

    Item's barcode

  • Name
    ForeignName
    Type
    string
    Constraint
    Description

    Foreign name of the item

  • Name
    SWW
    Type
    string
    Constraint
    Description

    Inventory tracking code

  • Name
    Season
    Type
    string
    Constraint
    Description

    Item's season

  • Name
    OnHand
    Type
    string
    Constraint
    Description

    Item's current stock

  • Name
    Divisor
    Type
    number
    Constraint
    Description

    The numerical value used as a denominator in calculations within the Graffiti products

  • Name
    IsTestProduct
    Type
    boolean
    Constraint
    Description

    Indicates if the item is a test product that has missing data

  • Name
    IsWebshopActive
    Type
    boolean
    Constraint
    Description

    Indicates if the item is active in the webshop

  • Name
    IsDangerousGood
    Type
    boolean
    Constraint
    Description

    Indicates if the item is a dangerous good

  • Name
    IsGraffitiProduct
    Type
    boolean
    Constraint
    Description

    Indicates if the item is a graffiti product

  • Name
    Color
    Type
    Color
    Constraint
    Description

    Color object representing the color data

  • Name
    Size
    Type
    Size
    Constraint
    Description

    Size object representing the size data

  • Name
    Supplier
    Type
    Supplier
    Constraint
    Description

    Supplier object representing the supplier data

  • Name
    Manufacturer
    Type
    Manufacturer
    Constraint
    Description

    Manufacturer object representing the manufacturer data

Name
ItemWithPrices
Type
object
Description

Represents information about an item with prices. Extension of the Items object

Fields
  • Name
    Items
    Type
    Items
    Constraint
    Description

    Fields of Items object

  • Name
    Prices
    Type
    [ItemPrices]
    Constraint
    Description

    List of ItemPrices

Name
ItemWithSpecialPrices
Type
object
Description

Represents information about an item with special prices. Extension of the Items object

Fields
  • Name
    Items
    Type
    Items
    Constraint
    Description

    Fields of Items object

  • Name
    SpecialPrices
    Type
    SpecialPrices]
    Constraint
    Description

    List of SpecialPrices

Name
Color
Type
object
Description

Represents information about a color.

Fields
  • Name
    Code
    Type
    string
    Constraint
    Description

    Color code

  • Name
    Name
    Type
    string
    Constraint
    Description

    Color name

  • Name
    U_LANGNAME
    Type
    string
    Constraint
    Description
  • Name
    HexColorCode
    Type
    string
    Constraint
    Description

    Hex value of color

Name
Size
Type
object
Description

Represents information about a size.

Fields
  • Name
    Code
    Type
    string
    Constraint
    Description

    Size code

  • Name
    Name
    Type
    string
    Constraint
    Description

    Size name

Name
Size
Type
object
Description

Represents information about an item group.

Fields
  • Name
    ItemGroupName
    Type
    string
    Constraint
    Description
  • Name
    Level1
    Type
    Level
    Constraint
    Description

    A Level object

  • Name
    Level2
    Type
    Level
    Constraint
    Description

    A Level object

  • Name
    Level3
    Type
    Level
    Constraint
    Description

    A Level object

Name
Level
Type
object
Description

Represents information about a group level.

Fields
  • Name
    Code
    Type
    string
    Constraint
    Description
  • Name
    Name
    Type
    string
    Constraint
    Description
Name
Supplier
Type
object
Description

Represents information about a supplier.

Fields
  • Name
    CardCode
    Type
    string
    Constraint
    Description

    Card code

  • Name
    CardName
    Type
    string
    Constraint
    Description

    Card name

Name
Manufacturer
Type
object
Description

Represents information about a manufacturer.

Fields
  • Name
    FirmCode
    Type
    string
    Constraint
    Description

    Firm code

  • Name
    FirmName
    Type
    string
    Constraint
    Description

    Firm name

Name
ItemPrices
Type
object
Description

Represents information about a price.

Fields
  • Name
    Price
    Type
    string
    Constraint
    Description

    Price is ignored if AdditionalPrice is greater than 0

  • Name
    AdditionalPrice
    Type
    string
    Constraint
    Description

    AdditionalPrice has priority over Price

  • Name
    Currency
    Type
    string
    Constraint
    Description

    Currency of the price. Used with Price

  • Name
    AdditionalCurrency
    Type
    string
    Constraint
    Description

    Used with AdditionalPrice

  • Name
    PriceList
    Type
    PriceList
    Constraint
    Description

    A PriceList object

Name
SpecialPrices
Type
object
Description

Represents information about a special price.

Fields
  • Name
    CardCode
    Type
    string
    Constraint
    Description
  • Name
    Price
    Type
    string
    Constraint
    Description

    Price value

  • Name
    Discount
    Type
    string
    Constraint
    Description
  • Name
    Currency
    Type
    string
    Constraint
    Description

    Currency of the price

  • Name
    ListNum
    Type
    string
    Constraint
    Description
  • Name
    CreateDate
    Type
    string
    Constraint
    Description
  • Name
    UpdateDate
    Type
    string
    Constraint
    Description
  • Name
    PriceList
    Type
    PriceList
    Constraint
    Description

    A PriceList object

  • Name
    SpecialPricesDataAreas
    Type
    SpecialPricesDataAreas
    Constraint
    Description

    A SpecialPricesDataAreas object

Name
PriceList
Type
object
Description

Represents information about a price list.

Fields
  • Name
    ListNum
    Type
    string
    Constraint
    Description
  • Name
    Country
    Type
    string
    Constraint
    Description

    Country code in ISO format

  • Name
    PriceGroup
    Type
    string
    Constraint
    Description

    Price group key

  • Name
    Tax
    Type
    string
    Constraint
    Description
  • Name
    PrimaryCurrency
    Type
    PriceList
    Constraint
    Description
Name
SpecialPricesDataAreas
Type
object
Description

Represents information about a data area for special prices

Fields
  • Name
    CardCode
    Type
    string
    Constraint
    Description
  • Name
    LineNum
    Type
    string
    Constraint
    Description
  • Name
    ListNum
    Type
    string
    Constraint
    Description
  • Name
    Price
    Type
    string
    Constraint
    Description
  • Name
    Currency
    Type
    string
    Constraint
    Description
  • Name
    FromDate
    Type
    string
    Constraint
    Description
  • Name
    ToDate
    Type
    string
    Constraint
    Description
Name
DeliveryNotes
Type
object
Description

Represents information about a delivery note

Fields
  • Name
    DocEntry
    Type
    number
    Constraint
    Description
  • Name
    LineNum
    Type
    number
    Constraint
    Description
  • Name
    ExtOrderId
    Type
    string
    Constraint
    Description
  • Name
    TrackingNumber
    Type
    string
    Constraint
    Description
  • Name
    ItemCode
    Type
    string
    Constraint
    Description
  • Name
    TrnspName
    Type
    string
    Constraint
    Description
  • Name
    URL
    Type
    string
    Constraint
    Description
  • Name
    ItemType
    Type
    string
    Constraint
    Description
  • Name
    Quantity
    Type
    number
    Constraint
    Description