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 Sales API `tbint.io/sales`

The Sales API enables developers to access, manage, and create sales orders within a SAP system. It provides functionality for retrieving existing orders as well as adding new orders, allowing for seamless integration with specific sales channels.

Queries

Name

orders

Type

query

Description

Returns an Order list by a sales channel.

Arguments

Name
salesChannel
Type
string
Constraint
required
Description
The sales channel
Name
sortBy
Type
string
Constraint
Description
object by which to sort by
Name
skip
Type
Int
Constraint
Description
The number of items to skip for pagination.
Name
take
Type
number
Constraint
Description
The number of items to take. max: 10000

Returns

Name
Order
Type

Constraint
Description
An Order object with all requested fields

Orders

	orders (
		salesChannel: "channel"
		sortBy: "orderId"
		sortOrder: ASC
		searchInput: "search"
		page: 1,
		take: 100
	) {[
	    {
	     # Order fields
	    }
	]}

Name

orderByOrderRefNumber

Type

query

Description

Returns an Order object by a sales channel and an order reference number.

Arguments

Name
salesChannel
Type
string
Constraint
required
Description
Name of sales channel
Name
orderRefNumber
Type
string
Constraint
required
Description
Order reference number

Returns

Name
Order
Type

Constraint
Description
An Order object with all requested fields

orderByOrderRefNumber

    orderByOrderRefNumber (
        salesChannel: "channel"
        orderRefNumber: "123"
    ) {
        # Order fields
    }

Name

orderByExtOrderId

Type

query

Description

Returns an Order object by a sales channel and an external order id.

Arguments

Name
salesChannel
Type
string
Constraint
required
Description
Name of sales channel
Name
extOrderId
Type
string
Constraint
required
Description
External order id

Returns

Name
Order
Type

Constraint
Description
An Order object with all requested fields

orderByExtOrderId

    orderByExtOrderId (
        salesChannel: "channel"
        extOrderId: "123"
    ) {
        # Order fields
    }

Mutations

Name

createOrderB2C

Type

mutation

Description

Returns the order reference number of the created sales order.

Arguments

Name
channel
Type
string
Constraint
required
Description
Channel name
Name
customer
Type
CustomerInputB2C
Constraint
required
Description
Customer input for B2C client
Name
order
Type
OrderInput
Constraint
required
Description
Order data

Returns

Name
OrderRefNumber
Type
number
Constraint
Description
Reference number of created order

Create Order B2C

	createOrderB2C (
		salesChannel: "channel"
        customer: {
            # Customer Input fields
        }
        order: {
            # Order Input fields
        }
	) {
	    OrderRefNumber: 1
	}

Name

createOrderB2B

Type

mutation

Description

Returns the order reference number of the created sales order.

Arguments

Name
channel
Type
string
Constraint
required
Description
Channel name
Name
customer
Type
CustomerInputB2B
Constraint
required
Description
Customer input for B2B client
Name
order
Type
OrderInput
Constraint
required
Description
Order data

Returns

Name
OrderRefNumber
Type
number
Constraint
Description
Reference number of created order

Create Order B2B

	createOrderB2B (
		salesChannel: "channel"
        customer: {
            # Customer Input fields
        }
        order: {
            # Order Input fields
        }
	) {
	    OrderRefNumber: 1
	}

Input Objects

Name

customerInputB2C

Type

input_object

Description

Input fields for customer

Arguments

Name
customerNumber
Type
string
Constraint
required
Description
Unique identifier for the customer.
Name
firstName
Type
string
Constraint
required
Description
Customer's first name
Name
lastName
Type
string
Constraint
required
Description
Customer's last name
Name
emailAddress
Type
string
Constraint
required
Description
Customer's email address
Name
shippingAddress
Type
AddressInput
Constraint
required
Description
Customer's shipping address
Name
billingAddress
Type
AddressInput
Constraint
required
Description
Customer's billing address
Name
phoneNumber
Type
string
Constraint
Description
Customer's phone number
Name
languageCode
Type
Language
Constraint
Description
Customer's language

Customer input B2B

	customer: {
		customerNumber: "00000000"
		firstName: "John"
		lastName: "Doe"
		emailAddress: "john.doe@test.com"
		shippingAddress: {
            # Address Input fields
		}
		billingAddress: {
            # Address Input fields
		}
	}

Name

customerInputB2B

Type

input_object

Description

Input fields for customer

Arguments

Name
customerNumber
Type
string
Constraint
required
Description
Unique identifier for the customer.
Name
companyName
Type
string
Constraint
required
Description
Company's name
Name
emailAddress
Type
string
Constraint
required
Description
Customer's email address
Name
shippingAddress
Type
AddressInput
Constraint
required
Description
Customer's shipping address
Name
billingAddress
Type
AddressInput
Constraint
required
Description
Customer's billing address
Name
phoneNumber
Type
string
Constraint
Description
Customer's phone number
Name
postNumber
Type
string
Constraint
Description
Post number for the collection points
Name
addition
Type
string
Constraint
Description
Addition to the address
Name
languageCode
Type
Language
Constraint
Description
Customer's language

Customer input B2C

	customer: {
		customerNumber: "00000000"
		companyName: "Company Y"
		emailAddress: "company.y@test.com"
		shippingAddress: {
            # Address Input fields
		}
		billingAddress: {
            # Address Input fields
		}
	}

Name

AddressInput

Type

input_object

Description

Input fields for address

Arguments

Name
city
Type
string
Constraint
required
Description
City of the address
Name
street
Type
string
Constraint
required
Description
Street of the address
Name
country
Type
Country
Constraint
required
Description
Country of the address
Name
zipCode
Type
string
Constraint
required
Description
Zip code of address
Name
block
Type
string
Constraint
Description
Block of the address
Name
state
Type
string
Constraint
Description
State of the address
Name
county
Type
string
Constraint
Description
County of the address
Name
recipient
Type
string
Constraint
Description
Name of recipient
Name
recipientPhoneNumber
Type
string
Constraint
Description
Phone number of recipient
Name
recipientEmail
Type
string
Constraint
Description
Email of recipient
Name
postNumber
Type
string
Constraint
Description
Used for collection points. Ignored in billing address.

Address input

    {
        city: "City"
        street: "Street"
        block: "Address block"
        country: DE
        zipCode: "10115"
        recipient: "Esther Mude"
        recipientPhoneNumber: "06553334445"
        recipientEmail: "esther.mude@test.com"
    }

Name

OrderInput

Type

input_object

Description

Input fields for order

Arguments

Name
orderNumber
Type
string
Constraint
required
Description
Unique identifier for the order.
Name
currency
Type
Currency
Constraint
required
Description
Order currency
Name
referenceNumber
Type
string
Constraint
Description
Order reference number
Name
totalAmount
Type
number
Constraint
Description
Total amount for order
Name
orderDate
Type
string
Constraint
Description
Date of order placement
Name
dueDate
Type
string
Constraint
Description
Due date of order
Name
comments
Type
string
Constraint
Description
Additional comments for order
Name
shippingCost
Type
number
Constraint
Description
Shipping cost for order
Name
shippingMethod
Type
string
Constraint
Description
Order shipping method. Shipping method has to exist in SAP!
Name
emailAddress
Type
string
Constraint
Description
Email address for order
Name
shippingEmailAddress
Type
string
Constraint
Description
Shipping email address
Name
shippingPhoneNumber
Type
string
Constraint
Description
Shipping phone number
Name
items
Type
ItemInput
Constraint
Description
Order items data
Name
payment
Type
PaymentInput
Constraint
Description
Order payment data

Order input

    order: {
      orderNumber: "000000000"
      referenceNumber: "000000000"
      orderDate: "2023-02-07"
      comments: "Additional comments about the order."
      shippingMethod: "Shipping Method"
      currency: EUR
      items: [{
         # Item Input fields
      }]
      payment: [{
        # Payment Input fields
      }]
    }

Name

ItemInput

Type

input_object

Description

Input fields for order item

Either itemCode or codeBars should be provided!

Arguments

Name
quantity
Type
number
Constraint
required
Description
Quantity for the item
Name
sku
Type
string
Constraint
Description
Item's SKU
Name
itemCode
Type
string
Constraint
Description
Product's item code
Name
itemId
Type
string
Constraint
Description
External Item ID
Name
codeBars
Type
string
Constraint
Description
Product's barcode
Name
deliveryDate
Type
string
Constraint
Description
Delivery date for the item
Name
priceAfterVAT
Type
number
Constraint
Description
Ignored if a voucher is used
Name
unitPrice
Type
number
Constraint
Description
Price that used when using a voucher
Name
discountPercent
Type
number
Constraint
Description
Discount percent of the used voucher

Item input

    [
        {
              sku: "0"
              itemCode: "000000000",
              quantity: 1,
              unitPrice: 0
              discountPercent: 0,
              deliveryDate: "2023-02-07"
         }
         ...
     ]

Name

PaymentInput

Type

input_object

Description

Input fields for order payment

Arguments

Name
paymentMethod
Type
string
Constraint
required
Description
Payment method. Payment method should exist in SAP!
Name
amount
Type
number
Constraint
required
Description
Payment amount
Name
transactionCode
Type
string
Constraint
required
Description
Transaction code of payment
Name
comments
Type
string
Constraint
Description
Additional comments for the payment

Payment input

    [
        {
             paymentMethod: "Payment Method",
             amount: 10
             transactionCode: "000000000"
         }
         ...
     ]

Objects

Name

Order

Type

object

Description

Represents information about an order.

Fields

Name
orderId
Type
number
Constraint
Description
Internal SAP ID
Name
orderRefNumber
Type
number
Constraint
Description
Internal SAP order reference
Name
extOrderID
Type
string
Constraint
Description
External order ID
Name
channel
Type
string
Constraint
Description
Order channel
Name
deliveryDate
Type
string
Constraint
Description
Order delivery date
Name
orderStatus
Type
string
Constraint
Description
Status of the order. Possible values: O: Open, C: Close
Name
customerReferenceNumber
Type
string
Constraint
Description
External reference number third-party system
Name
customerId
Type
string
Constraint
Description
Internal Customer Number
Name
customerName
Type
string
Constraint
Description
Customer name
Name
orderTotal
Type
number
Constraint
Description
Order total value
Name
paymentMethod
Type
string
Constraint
Description
Payment method for order
Name
currency
Type
string
Constraint
Description
Currency of the order
Name
comments
Type
string
Constraint
Description
Comments on the order
Name
canceled
Type
string
Constraint
Description
Indicates if the order is canceled. Y=Yes, N=No
Name
confirmed
Type
string
Constraint
Description
Indicates if the order is confirmed. Y=Yes, N=No
Name
email
Type
string
Constraint
Description
Email address for order
Name
createDate
Type
string
Constraint
Description
Order creation date
Name
updateDate
Type
string
Constraint
Description
Order update date
Name
items
Type
[OrderItem]
Constraint
Description
List of OrderItem object
Name
addressExtension
Type
AddressExtension
Constraint
Description
AddressExtension object

Name

OrderItem

Type

object

Description

Represents information about an order item.

Fields

Name
itemCode
Type
string
Constraint
Description
Item code
Name
barcode
Type
string
Constraint
Description
Item barcode
Name
extItemId
Type
float
Constraint
Description
External item id
Name
docEntry
Type
number
Constraint
Description
Item doc entry
Name
lineNum
Type
number
Constraint
Description
Item line number
Name
model
Type
string
Constraint
Description
Item model
Name
color
Type
string
Constraint
Description
Item color
Name
size
Type
string
Constraint
Description
Item size
Name
quantity
Type
number
Constraint
Description
Quantity of item
Name
openQuantity
Type
number
Constraint
Description
Open quantity of item
Name
price
Type
number
Constraint
Description
Item price
Name
priceAfterVAT
Type
number
Constraint
Description
Item price after VAT
Name
discountPercent
Type
number
Constraint
Description
Item discount percent
Name
currency
Type
string
Constraint
Description
Item price currency
Name
lineStatus
Type
string
Constraint
Description
Item status
Name
shippingDate
Type
string
Constraint
Description
Shipping date for item
Name
description
Type
string
Constraint
Description
Description for item
Name
color
Type
string
Constraint
Description
Color of item
Name
size
Type
string
Constraint
Description
Size of item
Name
allowPartialDeliveryLine
Type
boolean
Constraint
Description
Allow partial delivery line

Name

AddressExtension

Type

object

Description

Represents information about an order address.

Fields

Name
country
Type
string
Constraint
Description
Address country
Name
state
Type
string
Constraint
Description
Address state
Name
city
Type
string
Constraint
Description
Address city
Name
zipCode
Type
string
Constraint
Description
Address zip code
Name
street
Type
string
Constraint
Description
Address street
Name
recipientName
Type
string
Constraint
Description
Address recipient name
Name
addressExtra
Type
string
Constraint
Description
Address extra
Name
telephone
Type
string
Constraint
Description
Address telephone
Name
email
Type
string
Constraint
Description
Address email

Enums

Name

Order

Type

enum

Description

The set of valid values for sorting results.

Valid values

Name
ASC
Type
ASC
Constraint
Description
Sort in ascending order.
Name
DESC
Type
DESC
Constraint
Description
Sort in descending order.

Name

Country

Type

enum

Description

The set of valid values for Country. Two digit ISO country codes.

Valid values

Name
DE
Type
DE
Constraint
Description
ISO country code for Germany
Name
CH
Type
CH
Constraint
Description
ISO country code for Switzerland
Name
CX
Type
CX
Constraint
Description
ISO country code for Australia

For all the possible values please check the country ISO codes.

Name

Language

Type

enum

Description

The set of valid values for Language. Two digit ISO language codes.

Valid values

Name
EN
Type
EN
Constraint
Description
ISO language code for English
Name
DE
Type
DE
Constraint
Description
ISO language code for German
Name
IT
Type
IT
Constraint
Description
ISO language code for Italia

For all the possible values please check the language ISO codes.

Name

Currency

Type

enum

Description

The set of valid values for Currency. Two digit ISO currency codes.

Valid values

Name
EUR
Type
EUR
Constraint
Description
ISO currency code for Euro
Name
USD
Type
USD
Constraint
Description
ISO currency code for US Dollar
Name
CHF
Type
CHF
Constraint
Description
ISO currency code for Swiss Franc
Name
GBP
Type
GBP
Constraint
Description
ISO currency code for British Pound

For all the possible values please check the currency ISO codes.

TBInt Sales API tbint.io/sales

Table of contents

Queries

Mutations

Input Objects

Objects

Enums

Queries

Orders

orderByOrderRefNumber

orderByExtOrderId

Mutations

Create Order B2C

Create Order B2B

Input Objects

Customer input B2B

Customer input B2C

Address input

Order input

Item input

Payment input

Objects

Enums

TBInt Sales API `tbint.io/sales`