I/O Docs: API Documentation

• Approvals REST

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Create

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Change

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Cancel

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Goods Receipts

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Create NoSe

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Change NoSe

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• PO Cancel NoSe

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Goods Receipt NoSe

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevCostCenterPull

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevCompanyCodePulls

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevGeneralLedgerPull

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevCreatePurchaseOrder

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevReceipts

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevChangePurchaseOrder

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevCancelPurchaseOrder

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• DevCreatePurchaseOrderNordics

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Submit to Broker Method

  • List Methods
  • Expand Methods

  • POST send v1/broker/

    Submits to Broker

    Parameter	Value	Type	Description
    sender		string	Sender
    receiver		string	Receiver
    documentType		string	TN doc type
    target		string	Target
    transactionID		string	Transaction ID
    source		string	Source
    payload		string	Payload
    format	json xml	string	Content type

• Customer

  • List Methods
  • Expand Methods

  • GET details v1/customer/details

    Returns customer information

    Parameter	Value	Type	Description
    CUSTOMER_NUMBER		string	Customer number
    DISTRIBUTION_CHANNEL		string	Distribution Channel
    SALES_ORGANIZATION		string	Sales Organization
    LANGUAGE		string	Language needed for response
    format	json xml	string	Content type

  • GET orderHistory v1/customer/orderHistory

    Order history

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET orderDetails v1/customer/orderDetails

    Order details

    Parameter	Value	Type	Description
    customer		string	Customer number
    orderNumber		string	Order number
    format	json xml	string	Content type

  • GET deliveryHistory v1/customer/deliveryHistory

    Deliveries list

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET serviceTicketsList v1/customer/serviceTicket/history

    Service Ticket List

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET routeDetails v1/customer/routeDetails

    Route Details

    Parameter	Value	Type	Description
    customer		string	Customer number
    date		string	Route date
    format	json xml	string	Content type

• Customer

  • List Methods
  • Expand Methods

  • GET details v1/customer/details

    Returns customer information

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET orderHistory v1/customer/orderHistory

    Order history

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET orderDetails v1/customer/orderDetails

    Order details

    Parameter	Value	Type	Description
    customer		string	Customer number
    orderNumber		string	Order number
    format	json xml	string	Content type

  • GET deliveryHistory v1/customer/deliveryHistory

    Deliveries list

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET serviceTicketsList v1/customer/serviceTicket/history

    Service Ticket List

    Parameter	Value	Type	Description
    customer		string	Customer number
    format	json xml	string	Content type

  • GET routeDetails v1/customer/routeDetails

    Route Details

    Parameter	Value	Type	Description
    customer		string	Customer number
    date		string	Route date
    format	json xml	string	Content type

  • GET Get Orders v1/customer/order/:order

    Get Order or List of Orders

    Parameter	Value	Type	Description
    :order		string	Order number
    customer		string	Customer Number
    format	json xml	string	Content type

  • POST Create Orders v1/customer/order/:order

    Create or Update Order

    Parameter	Value	Type	Description
    :order		string	Order number
    format	json xml	string	Content type
    Content-Type		string	Content type of the payload

    Request Body

    { "CUSTOMER_NUMBER":"", "EMAIL":"", "DELIVERY_DATE":"", "SALES_ORGANIZATION":"", "DISTRIBUTION_CHANNEL":"", "DIVISION":"", "PURCHASE_ORDER_NUMBER":"", "DELIVERY_FROM":"", "DELIVERY_TO":"", "CUSTOMER_MESSAGE_IN":"", "ORDER_ITEMS_IN":[ { "ITEM_NUMBER":"", "HIGHER_LEVEL_ITEM":"", "MATERIAL_NUMBER":"", "ALTERNATIVE_ITEM":"", "DELIVERY_GROUP":"", "TARGET_QUANTITY_SALES_UNITS":"" } ] }

    { "CUSTOMER_NUMBER":"", "EMAIL":"", "DELIVERY_DATE":"", "SALES_ORGANIZATION":"", "DISTRIBUTION_CHANNEL":"", "DIVISION":"", "PURCHASE_ORDER_NUMBER":"", "DELIVERY_FROM":"", "DELIVERY_TO":"", "CUSTOMER_MESSAGE_IN":"", "ORDER_ITEMS_IN":[ { "ITEM_NUMBER":"", "HIGHER_LEVEL_ITEM":"", "MATERIAL_NUMBER":"", "ALTERNATIVE_ITEM":"", "DELIVERY_GROUP":"", "TARGET_QUANTITY_SALES_UNITS":"" } ] }
  • POST Get Pricing v1/customer/order/pricing/

    Get Corrected Pricing

    Parameter	Value	Type	Description
    format	json xml	string	Content type
    Content-Type		string	Content type of the payload

    Request Body

    { "CUSTOMER_NUMBER":"", "EMAIL":"", "DELIVERY_DATE":"", "SALES_ORGANIZATION":"", "DISTRIBUTION_CHANNEL":"", "DIVISION":"", "PURCHASE_ORDER_NUMBER":"", "ORDER_ITEMS_IN":[ { "ITEM_NUMBER":"", "HIGHER_LEVEL_ITEM":"", "MATERIAL_NUMBER":"", "ALTERNATIVE_ITEM":"", "DELIVERY_GROUP":"", "TARGET_QUANTITY_SALES_UNITS":"" } ] }

    { "CUSTOMER_NUMBER":"", "EMAIL":"", "DELIVERY_DATE":"", "SALES_ORGANIZATION":"", "DISTRIBUTION_CHANNEL":"", "DIVISION":"", "PURCHASE_ORDER_NUMBER":"", "ORDER_ITEMS_IN":[ { "ITEM_NUMBER":"", "HIGHER_LEVEL_ITEM":"", "MATERIAL_NUMBER":"", "ALTERNATIVE_ITEM":"", "DELIVERY_GROUP":"", "TARGET_QUANTITY_SALES_UNITS":"" } ] }
  • POST Cancel Orders v1/customer/order/cancel/:order

    Cancel an Order

    Parameter	Value	Type	Description
    :order		string	Order number
    email		string	Email
    format	json xml	string	Content type

• Send Email Method

  • List Methods
  • Expand Methods

  • POST send v1/email/send

    Sends email

    Parameter	Value	Type	Description
    fromAddress		string	From address
    toAddress		string	To address(es) separated by commas
    ccAddress		string	CC address(es) separated by commas
    bccAddress		string	BCC address(es) separated by commas
    subject		string	Subject
    body		string	Body
    format	json xml	string	Content type

• Customer Methods

  • List Methods
  • Expand Methods

  • GET customer by equipment number /equipment/customer/

    Returns customer number, searching by equipment number

    Parameter	Value	Type	Description
    equipment		string	Equipment
    format	json xml	string	Content type

• Customer Methods

  • List Methods
  • Expand Methods

  • GET customer by equipment number /equipment/customer/

    Returns customer number, searching by equipment number

    Parameter	Value	Type	Description
    equipment		string	Equipment
    format	json xml	string	Content type

• Equipment Request

  • List Methods
  • Expand Methods

  • GET Get New Equipment Request /equipmentrequest/new/

    Returns equipment request object list

    Parameter	Value	Type	Description
    plant		string	Plant
    format	json xml	string	Content type

  • GET Get Complete Equipment Request /equipmentrequest/complete/

    Returns equipment request object list

    Parameter	Value	Type	Description
    plant		string	Plant
    format	json xml	string	Content type

  • POST Update Equipment Request /equipmentrequest/:Name

    Updates single equipment request object

    Parameter	Value	Type	Description
    :Name		string	Name of ER
    transporterstatus	New_Equipment_Request Exported Planned Incomplete_Group EC_Planning_Action_Requested EC_Planning_Action_Completed Full_Service_Informed Rejected_by_Transporter Completed_by_Transporter	string	Transport Status
    transportercategory		string	Transporter Category
    transportercategorydescription		string	Transporter Category Description
    transportercomments		string	Transporter Comments
    deliverydate		string	Delivery Date (yyyyMMdd)
    completiondate		string	Completion Date (yyyyMMdd)
    contactpersonbyinstall		string	Contact Person by install
    contacttelephone		string	Contact telephone
    format	json xml	string	Content type

• Outlet Request

  • List Methods
  • Expand Methods

  • GET Get Outlet Request /repoutlet/:EID

    Returns equipment request object list

    Parameter	Value	Type	Description
    :EID		string	EID of the user
    format	json xml	string	Content type

  • GET Get Theme Request /reptheme/:ID

    Returns equipment request object list

    Parameter	Value	Type	Description
    :ID		string	ID of the user
    format	json xml	string	Content type

• Outlet Request

  • List Methods
  • Expand Methods

  • GET Get Employee Details Request /idm/employeeId/

    Returns system details of the user

    Parameter	Value	Type	Description
    eid		string	EID of the user
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

  • GET Get Role Description /idm/description/

    Returns description of a role

    Parameter	Value	Type	Description
    role		string	role
    system		string	system
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

  • GET Get Role of T-Code /idm/role/

    Returns T-Code of a role

    Parameter	Value	Type	Description
    tcode		string	T-Code
    system		string	system
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

  • GET Search All Texts /idm/

    Searches all fields for given Text

    Parameter	Value	Type	Description
    text		string	Text for search
    system		string	system
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

• Mobile Ordering

  • List Methods
  • Expand Methods

  • GET inventory mobileOrdering/v1/inventory/:employee

    Returns inventory for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET materialMaster mobileOrdering/v1/materialMaster/:employee

    Returns material master for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET orderHistory mobileOrdering/v1/orderHistory/:employee

    Returns order history for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET promo mobileOrdering/v1/promo/:employee

    Returns promo materials for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET roundingRules mobileOrdering/v1/roundingRules/:employee

    Returns rounding rules for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET visitList mobileOrdering/v1/visitList/:employee

    Returns visit list for employee ID

    Parameter	Value	Type	Description
    :employee		string	Employee ID
    :Accept	application/json text/xml	string	Content type

  • GET projectedInventory mobileOrdering/v1/projectedInventory/:customer

    Projected inventory

    Parameter	Value	Type	Description
    :customer		string	Customer number
    :Accept	application/json text/xml	string	Content type

  • POST submitOrder mobileOrdering/v1/submitOrder

    Creates or updates an order in SAP

    Parameter	Value	Type	Description
    Accept	application/json text/xml	string	Content type
    deliveryDate		string	Delivery date
    distributionChannel		string	Distribution channel
    division		string	Division
    employeeID		string	Employee ID
    orderType		string	Order type
    outletNumber		string	Outlet number
    purchaseOrderNumber		string	Purchase order number
    sapOrderNumber		string	SAP order number
    salesOrganization		string	Sales organization
    dispatcherNote		string	Dispatcher note
    driverNote		string	Driver note
    Materials		object	Materials

• Product Methods

  • List Methods
  • Expand Methods

  • GET search /product/search

    Returns product search results

    Parameter	Value	Type	Description
    query		string	Keyword search query against product description, with multi-character wildcard operator (e.g. FANTA, COKE*)
    maxRows		int	Maximum number of rows to return
    language	EN FR NL	string	Language
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

  • GET details /product/details

    Returns product description details

    Parameter	Value	Type	Description
    materials		string	Materials separated by comma (e.g. 408001, 409528)
    language	EN FR NL	string	Language
    format	json xml	string	Content type
    callback		string	JSONP callback name (e.g. myFunctionName)

• Send SMS Method

  • List Methods
  • Expand Methods

  • POST send v1/sms/send

    Sends SMS

    Parameter	Value	Type	Description
    to		string	Send SMS to
    body		string	Message to send
    format	json xml	string	Content type

• getDetails

  • List Methods
  • Expand Methods

  • GET details /supplier/details

    Returns supplier information

    Parameter	Value	Type	Description
    supplier		string	Supplier information
    format	json xml	string	Content type

  • GET openItems /supplier/openItems

    Returns supplier open items

    Parameter	Value	Type	Description
    supplier		string	Supplier information
    format	json xml	string	Content type

  • GET closedItems /supplier/closedItems

    Returns supplier closed items

    Parameter	Value	Type	Description
    supplier		string	Supplier information
    format	json xml	string	Content type

• System Status Method

  • List Methods
  • Expand Methods

  • GET Status systemstatus/v1/:serverCluster

    Returns Server Status

    Parameter	Value	Type	Description
    :serverCluster	webservices	string	Output status for specific server cluster
    Accept	application/json text/xml	string	Content type for the response