ERP SD Sales Order Proxy

Overview

The ERP SD Sales Order Proxy service is a business service that is used for manipulating sales orders in the connected SAP ERP system.

Using this service, you can:

  • Get recent ERP SD sales orders using the relevant ERP customer ID.
  • Get all ERP SD sales orders using the relevant ERP customer ID, material ID, and creation date.
  • Get detailed information of an ERP SD sales order using the relevant sales order ID.
  • Simulate ERP sales order creation.
  • Create ERP SD sales orders using two approaches with different BAPIs. For more information about the BAPIs, see SAP Note 93091.
  • Change ERP SD sales orders using a custom remote-enabled function module. For more information about the function module, see SAP Note 2339873.

Before you use the service, you need to configure the ERP system settings in the ERP SD Configuration service.


API Reference

/{tenant}/erpsalesorder/customer/{customerId}/recentItems

Get recent ERP SD sales order items.

/{tenant}/erpsalesorder/customer/{customerId}/recentItems

get

Get recent ERP SD sales orders for the given ERP customer.

The statuses that are treated to be CLOSE: completed
The statuses that are treated to be OPEN: created

Required scope: hybris.sdorderproxy_view

/{tenant}/erpsalesorder/customer/{customerId}/allItems

Get brief information of ERP SD sales order items.

/{tenant}/erpsalesorder/customer/{customerId}/allItems

get

Get a list of ERP SD sales orders.

Required scope: hybris.sdorderproxy_view

/{tenant}/erpsalesorder/{salesorderId}

Manage a specific ERP sales order.

/{tenant}/erpsalesorder/{salesorderId}

get

Get the details of specific ERP SD sales order using the sales order identifier and the required ERP configuration parameters.

Required scope: hybris.sdorderproxy_view

put

Update a specific ERP SD sales order. Before using the operation, you need to implement the SAP note 2339873 to create a custom function module. For more information about this note, find [SAP Note 2339873] at http://service.sap.com/sap/support/notes/2339873.

When you change an ERP SD Sales Order, you can change the relevant information, for example:

  • Insert ERP SD Sales Order items
  • Delete ERP SD Sales Order items
  • Change ERP SD Sales Order items materials and quantity and some other information

Required scope: hybris.sdorderproxy_manage

/{tenant}/erpsalesorder/simulate

Simulate creation of an ERP SD sales order.

/{tenant}/erpsalesorder/simulate

post

Simulate creation of an ERP SD sales order via JsonRPC protocol to call BAPI_SALESORDER_SIMULATE. By calling the resource and the operation, the availability and pricing are determined and returned.

Required scope: hybris.sdorderproxy_manage

/{tenant}/erpsalesorder/createsdorder1

Creation approach 1 of an ERP SD sales order

/{tenant}/erpsalesorder/createsdorder1

post

Create an ERP SD sales order using a JsonRPC post to execute BAPI_SALESORDER_CREATEFROMDAT1.

When you create an ERP SD sales order, you can specify the relevant information, for example:

  • Header information of sales order, such as document type, sales organization, distribution chain and division
  • Included line items, such as material identifier and number of items
  • Relevant partner, such as the billing partner and the shipping partner

Furthermore, before you create an ERP SD sales order, you can simulate the SD order using the relevant information mentioned in the creation case.

Required scope: hybris.sdorderproxy_manage.

/{tenant}/erpsalesorder/createsdorder2

Creation approach 2 of an ERP SD sales order

/{tenant}/erpsalesorder/createsdorder2

post

Create an ERP SD sales order using a JsonRPC post to call BAPI_SALESORDER_CREATEFROMDAT2. This method supports more input parameters than creation approach 1.

When you create an ERP SD sales order, you can specify the relevant information, for example:

  • Header information of sales order, such as document type, sales organization, distribution chain and division
  • Included line items, such as material identifier and number of items
  • Relevant partner, such as the billing partner and the shipping partner
  • Relevant schedule line
  • Number assignment of ERP SD sales order
  • Extension information for included line items

Furthermore, before you create an ERP SD sales order, you can simulate the SD order using the relevant information mentioned in the creation case.

Required scope: hybris.sdorderproxy_manage

/{tenant}/helpvalues

Help values for a single field.

/{tenant}/helpvalues

get

Get help values for a single field.

/{tenant}/multipleHelpValues

Help values for multiple fields.

/{tenant}/multipleHelpValues

get

Get help values for multiple fields.


Scopes

The table shows the scopes that the ERP SD Sales Order Proxy service supports.

SCOPEDESCRIPTION
hybris.sdorderproxy_viewRead ERP SD sales orders or related help values
hybris.sdorderproxy_manageCreate ERP SD sales orders

For more information about scopes, authorization, and authentication procedures for YaaS services, see Scopes and Authorization.


Order Creation Details

Use these endpoints to create ERP SD sales orders in the SAP ERP system:

  • /{tenant}/erpsalesorder/createsdorder1: Create an ERP SD sales order by running BAPI_SALESORDER_CREATEFROMDAT1.
  • /{tenant}/erpsalesorder/createsdorder2: Create an ERP SD sales order by running BAPI_SALESORDER_CREATEFROMDAT2.

The endpoint /{tenant}/erpsalesorder/createsdorder2 allows these advantages:

  • Upload of header and item texts
  • Upload of n conditions
  • Upload of n schedule lines
  • Connection to the Central Address Management (CAM) address (see SAP Note 195768)

Enter the ERP Sales Order data in the request body. The BAPIs handle data persistence, storage, and processing logic in the ERP Sales and Distribution system.

Enter, at minimum, the data for the sales order header (the ORDER_HEADER_IN structure) and the partner data (the ORDER_PARTNERS table) as input parameters.

Enter the item data into the ORDER_ITEMS_IN table. To allocate the item numbers manually, fill in the relevant fields. Otherwise, the system enters the data based on the custom settings, leaving the relevant fields blank.

Mandatory entries:

TABLEFIELDDESCRIPTION
ORDER_HEADER_INDOC_TYPESales document type
SALES_ORGSales organization
DISTR_CHANDistribution channel
DIVISIONDivision
ORDER_PARTNERSPARTN_ROLEPartner functions, SP (Sold-to Party)
PARTN_NUMBCustomer number
ORDER_ITEMS_INMATERIALMaterial number
REQ_QTYOrder quantity in sales unit

Use the BAPICCARD structure to transfer any payment card information, including the card identification data and the transaction data, which is performed in an external system.

If you want to work with payment card information, you must refer to the The Payment Card Industry Data Security Standard (PCI-DSS) that was jointly developed by major credit card companies in order to create a set of common industry security requirements for the protection of cardholder data. Compliance with this standard is relevant for companies processing credit card data. For more information, see http://www.pcisecuritystandards.org.

Complying with the PCI-DSS lies completely within the customer's responsibility, and we cannot guarantee the customer's compliance with the PCI-DSS.

Any measures to comply with the PCI-DSS must constantly be monitored and checked. For example, do not take credit card information using channels that record interaction data, such as the chat transcript, if you have not set up measures to delete this information in a subsequent step.

The following SAP Notes can support you regarding the implementation of payment card security aspects:

Note NumberDescription
766703FAQ: Credit card encryption in R/3 system
633462Encrypting credit card data
791178Credit card encryption in AR back end

These SAP Notes are application-specific. For general information, see the Payment Card Security Guide on SAP Service Marketplace at service.sap.com/securityguide > SAP Business Suite Applications > Payment Card Security. For updated general payment card security information, see SAP Note 1609917.

Please note that the PCI-DSS covers more than the steps and considerations provided in this document. It is your responsibility to ensure compliance with the PCI-DSS.

If there is no sales area in the sales order header, the system creates a sales area from the sold-to party or ship-to party entered in the partner table. If the system cannot create a clear sales area, you receive a system message, and the sales order is not created.

For more information about BAPIs, see SAP Note 93091 and the documentation for the BAPIs in the SAP ERP system.


Simulate the Creation of an ERP SD Sales Order

To determine availability and pricing, you might need to simulate the ERP sales order creation. The service uses the BAPI BAPI_SALESORDER_SIMULATE to simulate the creation of an ERP SD sales order. This BAPI has the same interface definition as the BAPI_SALESORDER_CREATEFROMDAT1 function, but in this case, the ERP system does not update the sales order. The endpoint {tenant}/erpsalesorder/simulate simulates the ERP SD order creation.

For more information, see the documentation for the BAPI in the SAP ERP system.


Create an ERP Sales Order

For the details about order creation, refer to the Order Creation Details.


Retrieve an ERP Sales Order

The service uses the BAPI BAPI_SALESORDER_GETLIST to retrieve ERP SD sales orders. Use these endpoints to retrieve ERP SD sales orders for a customer:

  • /{tenant}/erpsalesorder/customer/{customerId}/recentItems: Retrieve recent ERP SD sales order items for a specified ERP customer
  • /{tenant}/erpsalesorder/customer/{customerId}/allItems: Retrieve brief information about all ERP SD sales orders for a specified ERP customer

To use these endpoints, enter a valid ERP customer number in the URI parameter, and a sales organization as a query parameter. You can also filter sales orders by entering certain criteria. For example, when retrieving all ERP SD sales orders for a customer, you can filter the orders by material number (the qMaterialId parameter) and/or creation date (the qCreationDate parameter).

For more information, see the documentation for the BAPI BAPI_SALESORDER_GETLIST in the SAP ERP system.

To review the details of a specific ERP SD sales order with a sales order identifier, you can use the endpoint /{tenant}/erpsalesorder/{salesorderId}.

For more information, see the documentation for the BAPI BAPISDORDER_GETDETAILEDLIST in the SAP ERP system.


Update an ERP Sales Order

To update an ERP SD sales order, send a PUT request to the endpoint /{tenant}/erpsalesorder/{salesorderId}.

Before using this endpoint, create a new BAPI that combines the functions of the BAPIs BAPI_SALESORDER_CHANGE and BAPI_TRANSACTION_COMMIT in the SAP ERP system. When a user updates a sales order, the system calls the new BAPI. For more information, see SAP Note 2339873.

You can change a header, an item, a schedule line, and configuration data. Your request must follow these requirements:

  • Specify only the fields that you want to change.
  • Enter an X in the checkboxes to specify the fields to change.
  • Enter a U in the UPDATEFLAG field.
  • Always specify key fields when changing the data, including in the checkboxes.
  • The configuration is an exception here. To change the configuration, provide complete configuration information.
  • Maintain the quantities and dates in the schedule line data.
  • Use UPDATEFLAGS in your request to specify the type of an update you perform:
    • U = change
    • D = delete
    • I = add

The minimum requirements for an entry are:

  • Enter an order number in the SALESDOCUMENT structure
  • Enter key fields for changes
  • Specify the update indicator in the ORDER_HEADER_INX

For more information, see the documentation for the BAPI BAPI_SALESORDER_CHANGE in the SAP ERP system.

Example of the request body for updating a purchasing order number for a sales order:

{
    "ORDER_HEADER_IN" : {
         "PURCH_NO_C" : "testPO" },
     "ORDER_HEADER_INX" : {
        "UPDATEFLAG" : "U",
        "PURCH_NO_C" : "X" },
    "SALESDOCUMENT" : "0000075924",
    "SIMULATION" : "X"
}


Retrieve Help Values

In ERP sales orders, some fields have a set of predefined values and corresponding descriptions. Using this service, you can retrieve the help values, including the values and their descriptions, for the fields from the connected SAP ERP system.

The service supports these fields:

  • Payment Card Type (CCINS)
  • Shipping Conditions (VSBED)
  • Sales Unit (MSEHI)
  • Plant (WERKS)
  • Payment Terms (ZTERM)
  • Payment Method (ZLSCH)
  • Billing Block (FAKSP)
  • Delivery Block (LIFSP)
  • Item Category (PSTYV)
  • Reject Reason (ABGRU)
  • Schedule Line Category (ETTYP)
  • Incoterms (INCO1)
  • Delivery Priority (LPRIO)

You can use the endpoints below to operate with the help values:

  • /{tenant}/helpvalues: Retrieve help values for a single field
  • /{tenant}/multipleHelpValues: Retrieve help values for multiple fields

Example of the help values for Payment Terms (ZTERM) field, returned by the endpoint /{tenant}/helpvalues:

[
    {
        "language": "en",
        "key":"NT00",
        "value":"Payable upon receipt"},
    {
         "language": "en",
        "key":"NT30",
        "value":"Net due in 30 days"}
]


Retrieve ERP SD Sales Orders for a Customer

To retrieve the recent ERP SD Sales Orders for a specified customer, you need:

Request

  • Method: GET
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/customer/{customerId}/recentItems
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_view.
  • URI Parameters
    • {tenant}: The name of the current tenant
    • {customerId}: The ERP ID of the current customer
  • Query parameters:
    • qSalesOrganization: The Sales Organization parameter is required.
    • pageSize: The number of result entries allocated to one page. If there are more results than a single page can hold, additional pages become available.
    • pageNumber: The page number to be retrieved. Page numbering starts with one.

Response

The successful response returns a 200 status code. The query parameters provide convenient tools to structure the search results if the number of results is large. An example JSON content looks similar to the following:

{
  "numberOfClosedItems": 33,
  "numberOfOpenItems": 50,
  "recentClosedItems": [
    {
      "id": "0000000642",
      "name": "0000000642",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 11:13:08"
    },
    {
      "id": "0000000622",
      "name": "0000000622",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 10:09:05"
    },
    {
      "id": "0000000602",
      "name": "0000000602",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 09:38:24"
    }
  ],
  "recentOpenItems": [
    {
      "id": "0000000779",
      "name": "0000000779",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-02 09:24:38"
    },
    {
      "id": "0000000774",
      "name": "0000000774",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-02 09:04:58"
    },
    {
      "id": "0000000760",
      "name": "0000000760",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-01 10:43:58"
    }
  ]
}

To retrieve a list of ERP SD sales orders for a specified customer, you need:

Request

  • Method: GET
  • Request URL: https://api.beta.yaas.io/hybris/erpsdconfig/v1/{tenant}/erpsalesorder/customer/{customerId}/allItems
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_view.
  • URI Parameters
    • {tenant}: The name of the current tenant
    • {customerId}: The ERP ID of the current customer
  • Query parameters:
    • qSalesOrganization: The sales organization parameter is required.
    • qCreationDate: Sales order creation date
    • qMaterialId: Material ID
    • pageSize: The number of result entries allocated to one page. If there are more results than a single page can hold, additional pages become available.
    • pageNumber: The page number to be retrieved. Page numbering starts with one.

Response

The successful response returns a 200 status code. The query parameters provide convenient tools to structure the search results if the number of results is large. An example JSON content looks similar to the following:

{
  "numberOfClosedItems": 33,
  "numberOfOpenItems": 50,
  "recentClosedItems": [
    {
      "id": "0000000642",
      "name": "0000000642",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 11:13:08"
    },
    {
      "id": "0000000622",
      "name": "0000000622",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 10:09:05"
    },
    {
      "id": "0000000602",
      "name": "0000000602",
      "description": "Notebook X15",
      "statusDescription": "Completed",
      "modifiedAt": "2015-03-19 09:38:24"
    }
  ],
  "recentOpenItems": [
    {
      "id": "0000000779",
      "name": "0000000779",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-02 09:24:38"
    },
    {
      "id": "0000000774",
      "name": "0000000774",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-02 09:04:58"
    },
    {
      "id": "0000000760",
      "name": "0000000760",
      "description": "Notebook X15",
      "statusDescription": "Not delivered",
      "modifiedAt": "2015-09-01 10:43:58"
    }
  ]
}


Simulate the Creation of an ERP SD Sales Order

You can simulate the creation of an ERP SD sales order to determine the availability and pricing.

To simulate the creation of an ERP SD sales order, you need:

Request

  • Method: POST
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/simulate
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_manage.
  • URI Parameters
    • {tenant}: The name of the current tenant
  • Body: an ERP SD sales order with minimum information
{
  "ORDER_HEADER_IN" : {
    "DOC_TYPE" : "TA",
    "SALES_ORG" : "1000",
    "DISTR_CHAN" : "10",
    "DIVISION" : "10"
  },
  "ORDER_ITEMS_IN" : [ {
    "ITM_NUMBER" : 0,
    "HG_LV_ITEM" : 0,
    "MATERIAL" : "H15",
    "DLV_GROUP" : 0,
    "TARGET_QTY" : 1,
    "REQ_QTY" : 1,
    "REQ_TIME" : "02:14:00",
    "COND_VALUE" : 0.0,
    "COND_P_UNT" : 0
  } ],
  "ORDER_PARTNERS" : [ {
    "PARTN_ROLE" : "AG",
    "PARTN_NUMB" : "0000100012",
    "ITM_NUMBER" : 0
  }, {
    "PARTN_ROLE" : "RE",
    "PARTN_NUMB" : "0000100012",
    "ITM_NUMBER" : 0
  } ]
}

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
  "BILLING_PARTY" : {
    "PAYER" : "0000100012",
    "NAME" : "Booktree Inc.",
    "STREET" : "15 Harbor Road",
    "POSTL_CODE" : "92121",
    "CITY" : "San Diego",
    "LANGU" : "E",
    "COUNTRY" : "US",
    "CRED_LIMIT" : 0.0,
    "ORDER_VALS" : 0.0,
    "RCVBL_VALS" : 0.0,
    "CRED_LIAB" : 0.0,
    "VAL_LIMIT" : 0.0,
    "ACCNT_ASGN" : "01",
    "PMNTTRMS" : "0001",
    "ADD_VAL_DY" : 0
  },
  "RETURN" : {
    "LOG_MSG_NO" : 0
  },
  "ORDER_HEADERS_OUT" : [ {
    "NET_VAL_HD" : 48.0,
    "CURRENCY" : "USD"
  } ],
  "SHIP_TO_PARTY" : {
    "SHIP_TO" : "0000100012",
    "NAME" : "Booktree Inc.",
    "STREET" : "15 Harbor Road",
    "POSTL_CODE" : "92121",
    "CITY" : "San Diego",
    "LANGU" : "E",
    "DEST_CNTRY" : "US",
    "TRNSP_ZONE" : "0000000001",
    "REGION" : "CA",
    "TAXJURCODE" : "CA0000000",
    "DLV_PLANT" : "1000",
    "SHIP_COND" : "01",
    "ACCNT_GRP" : "YB01"
  },
  "SOLD_TO_PARTY" : {
    "SOLD_TO" : "0000100012",
    "NAME" : "Booktree Inc.",
    "STREET" : "15 Harbor Road",
    "POSTL_CODE" : "92121",
    "CITY" : "San Diego",
    "LANGU" : "E",
    "COUNTRY" : "US",
    "STAT_GROUP" : "1",
    "PRC_PROCED" : "1",
    "CUST_GROUP" : "02",
    "INCOTERMS1" : "EXW",
    "INCOTERMS2" : "Manufacturing",
    "MAX_PL_DLV" : 0.0,
    "DLV_PRIO" : 2,
    "CURRENCY" : "USD",
    "SHIP_COND" : "01",
    "ORDER_PROB" : 100
  },
  "EXTENSIONIN" : [ ],
  "MESSAGETABLE" : [ ],
  "ORDER_CCARD" : [ ],
  "ORDER_CCARD_EX" : [ ],
  "ORDER_CFGS_BLOB" : [ ],
  "ORDER_CFGS_INST" : [ ],
  "ORDER_CFGS_PART_OF" : [ ],
  "ORDER_CFGS_REF" : [ ],
  "ORDER_CFGS_VALUE" : [ ],
  "ORDER_CONDITION_EX" : [ {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 11,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "PR00",
    "SD000COND_VALUE" : 485.0,
    "CURRENCY" : "USD",
    "COND_UNIT" : "EA",
    "COND_P_UNT" : 1.0,
    "CURR_ISO" : "USD",
    "CD_UNT_ISO" : "EA",
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "C",
    "CONBASEVAL" : 0.001,
    "CONEXCHRAT" : 1.0,
    "NUMCONVERT" : 1.0,
    "DENOMINATO" : 1.0,
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 40,
    "CONDCOUNT" : 1,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.49,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "B",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "COND_NO" : "0000007610",
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 104,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "K007",
    "SD000COND_VALUE" : -2.0,
    "COND_P_UNT" : 0.0,
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "A",
    "CONBASEVAL" : 0.49,
    "CONEXCHRAT" : 0.0,
    "NUMCONVERT" : 0.0,
    "DENOMINATO" : 0.0,
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 10,
    "CONDCOUNT" : 1,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : -0.01,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "A",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "COND_NO" : "0000007620",
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 911,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "AZWR",
    "SD000COND_VALUE" : 0.0,
    "CURRENCY" : "USD",
    "COND_P_UNT" : 0.0,
    "CURR_ISO" : "USD",
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "B",
    "CONBASEVAL" : 0.048,
    "CONEXCHRAT" : 1.0,
    "NUMCONVERT" : 0.0,
    "DENOMINATO" : 0.0,
    "CONDTYPE" : "e",
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 0,
    "CONDCOUNT" : 0,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.0,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "A",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 915,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "UTXJ",
    "SD000COND_VALUE" : 0.0,
    "COND_P_UNT" : 0.0,
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "A",
    "CONBASEVAL" : 0.48,
    "CONEXCHRAT" : 0.0,
    "NUMCONVERT" : 0.0,
    "DENOMINATO" : 0.0,
    "CONDTYPE" : "1",
    "STAT_CON" : "X",
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 10,
    "CONDCOUNT" : 1,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.0,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "D",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "COND_NO" : "0000007291",
    "TAX_CODE" : "O1",
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 916,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "JR1",
    "SD000COND_VALUE" : 6.0,
    "COND_P_UNT" : 0.0,
    "APPLICATIO" : "TX",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "A",
    "CONBASEVAL" : 0.48,
    "CONEXCHRAT" : 0.0,
    "NUMCONVERT" : 0.0,
    "DENOMINATO" : 0.0,
    "CONDTYPE" : "1",
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 10,
    "CONDCOUNT" : 1,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.03,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "D",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "COND_NO" : "0000007613",
    "TAX_CODE" : "O1",
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 930,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "SKTO",
    "SD000COND_VALUE" : 0.0,
    "COND_P_UNT" : 0.0,
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "A",
    "CONBASEVAL" : 0.51,
    "CONEXCHRAT" : 0.0,
    "NUMCONVERT" : 0.0,
    "DENOMINATO" : 0.0,
    "CONDTYPE" : "E",
    "STAT_CON" : "X",
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 0,
    "CONDCOUNT" : 0,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.0,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "A",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  }, {
    "ITM_NUMBER" : 10,
    "COND_ST_NO" : 940,
    "SD000COND_COUNT" : 1,
    "SD000COND_TYPE" : "VPRS",
    "SD000COND_VALUE" : 250.0,
    "CURRENCY" : "USD",
    "COND_UNIT" : "EA",
    "COND_P_UNT" : 1.0,
    "CURR_ISO" : "USD",
    "CD_UNT_ISO" : "EA",
    "APPLICATIO" : "V",
    "CONPRICDAT" : "2016-03-10",
    "CALCTYPCON" : "C",
    "CONBASEVAL" : 0.001,
    "CONEXCHRAT" : 1.0,
    "NUMCONVERT" : 1.0,
    "DENOMINATO" : 1.0,
    "CONDTYPE" : "G",
    "STAT_CON" : "X",
    "CONDORIGIN" : "A",
    "ACCESS_SEQ" : 0,
    "CONDCOUNT" : 0,
    "ROUNDOFFDI" : 0.0,
    "CONDVALUE" : 0.25,
    "CURRENCY_2" : "USD",
    "CURR_ISO_2" : "USD",
    "CONDCNTRL" : "A",
    "CONDCLASS" : "B",
    "FACTBASVAL" : 0.0,
    "SCALBASVAL" : 0.0,
    "FACTCONBAS" : 0.0,
    "CONDCOINHD" : 0
  } ],
  "ORDER_INCOMPLETE" : [ {
    "ITM_NUMBER" : 0,
    "SCHED_LINE" : 0,
    "TABLE_NAME" : "VBKD",
    "FIELD_NAME" : "BSTKD",
    "FIELD_TEXT" : "PO number"
  } ],
  "ORDER_ITEMS_IN" : [ {
    "ITM_NUMBER" : 0,
    "HG_LV_ITEM" : 0,
    "MATERIAL" : "H15",
    "DLV_GROUP" : 0,
    "TARGET_QTY" : 1,
    "REQ_QTY" : 1,
    "REQ_TIME" : "02:14:00",
    "COND_VALUE" : 0.0,
    "COND_P_UNT" : 0,
    "COND_VAL1" : 0.0,
    "VAL_CON_I" : 0,
    "REF_DOC_IT" : 0,
    "CD_VALUE2" : 0.0,
    "CD_P_UNT2" : 0,
    "CD_VALUE3" : 0.0,
    "CD_P_UNT3" : 0,
    "CD_VALUE4" : 0.0,
    "CD_P_UNT4" : 0
  } ],
  "ORDER_ITEMS_OUT" : [ {
    "ITM_NUMBER" : 10,
    "MATERIAL" : "H15",
    "MAT_ENTRD" : "H15",
    "SHORT_TEXT" : "Notebook X15",
    "NET_VALUE" : 48.0,
    "CURRENCY" : "USD",
    "SD000SUBTOTAL_1" : 49.0,
    "SD000SUBTOTAL_2" : 48.0,
    "SD000SUBTOTAL_3" : 48.0,
    "SD000SUBTOTAL_4" : 0.0,
    "SD000SUBTOTAL_5" : 0.0,
    "SD000SUBTOTAL_6" : 0.0,
    "SALES_UNIT" : "EA",
    "QTY_REQ_DT" : 1,
    "DLV_DATE" : "2016-03-10",
    "REPL_TIME" : 0,
    "NET_VALUE1" : 0.48,
    "CURR_ISO" : "USD",
    "S_UNIT_ISO" : "EA",
    "REQ_QTY" : 0.001,
    "PLANT" : "1000",
    "TX_DOC_CUR" : 0.03,
    "TARGET_QTY" : 0.0,
    "TARGET_QU" : "EA",
    "T_UNIT_ISO" : "EA",
    "ITEM_CATEG" : "TAN",
    "SHIP_POINT" : "1000",
    "HG_LV_ITEM" : 0,
    "PROD_HIER" : "00001B000100000003",
    "MATL_GROUP" : "YBT01",
    "SUBTOTAL1" : 0.49,
    "SUBTOTAL2" : 0.48,
    "SUBTOTAL3" : 0.48,
    "SUBTOTAL4" : 0.0,
    "SUBTOTAL5" : 0.0,
    "SUBTOTAL6" : 0.0
  } ],
  "ORDER_PARTNERS" : [ {
    "PARTN_ROLE" : "AG",
    "PARTN_NUMB" : "0000100012",
    "ITM_NUMBER" : 0
  }, {
    "PARTN_ROLE" : "RE",
    "PARTN_NUMB" : "0000100012",
    "ITM_NUMBER" : 0
  } ],
  "ORDER_SCHEDULE_EX" : [ {
    "ITM_NUMBER" : 10,
    "SCHED_LINE" : 1,
    "SCHED_TYPE" : "CP",
    "RELFORDEL" : "X",
    "REQ_DATE" : "2016-03-10",
    "REQ_TIME" : "02:14:00",
    "REQ_QTY" : 0.001,
    "CONFIR_QTY" : 0.001,
    "SALES_UNIT" : "EA",
    "REQ_QTY1" : 0.001,
    "BASE_UOM" : "EA",
    "REQ_TYPE" : "01",
    "PLTYPE" : "1",
    "BUSIITNR" : 0,
    "SCHED_LIN1" : 0,
    "MAINT_REQ" : 0,
    "DATE_TYPE" : "1",
    "TP_DATE" : "2016-03-09",
    "MS_DATE" : "2016-03-09",
    "LOAD_DATE" : "2016-03-09",
    "GI_DATE" : "2016-03-09",
    "CORR_QTY" : 0.001,
    "GRP_DEFIN" : 0,
    "FORCAST_NR" : 0,
    "COMMIT_QTY" : 0.0,
    "SIZE2" : 0.0,
    "SIZE3" : 0.0,
    "SALESQTYNR" : 1.0,
    "SALESQTYDE" : 1.0,
    "AVAIL_CON" : "X",
    "MOVE_TYPE" : "601",
    "PREQ_ITEM" : 0,
    "GURANTEED" : 0.0,
    "MS_TIME" : "22:00:00",
    "TP_TIME" : "22:00:00",
    "LOAD_TIME" : "22:00:00",
    "GI_TIME" : "22:00:00"
  } ],
  "ORDER_SCHEDULE_IN" : [ ],
  "PARTNERADDRESSES" : [ ]
}


Create an ERP SD Sales Order

You can create an ERP SD sales order using two different approaches. For more details about order creation, see Order Creation Details.

Create an ERP SD sales order using BAPI BAPI_SALESORDER_CREATEFROMDAT1

This is the first approach to the order creation. As a minimum, you must enter the data for the sales order header (the ORDER_HEADER_IN structure) and the partner data (the ORDER_PARTNERS table) as input parameters.

To create an ERP SD sales order using BAPI BAPI_SALESORDER_CREATEFROMDAT1, you need:

Request

  • Method: POST
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/createsdorder1
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_manage.
  • URI Parameters
    • {tenant}: The name of the current tenant
  • Body
    {
    "ORDER_HEADER_IN" : {
      "DOC_TYPE" : "TA",
      "SALES_ORG" : "1000",
      "DISTR_CHAN" : "10",
      "DIVISION" : "10"
    },
    "ORDER_ITEMS_IN" : [ {
      "ITM_NUMBER" : 0,
      "HG_LV_ITEM" : 0,
      "MATERIAL" : "H15",
      "DLV_GROUP" : 0,
      "TARGET_QTY" : 1,
      "REQ_QTY" : 1,
      "REQ_TIME" : "02:14:00",
      "COND_VALUE" : 0.0,
      "COND_P_UNT" : 0
    } ],
    "ORDER_PARTNERS" : [ {
      "PARTN_ROLE" : "AG",
      "PARTN_NUMB" : "0000100012",
      "ITM_NUMBER" : 0
    }, {
      "PARTN_ROLE" : "RE",
      "PARTN_NUMB" : "0000100012",
      "ITM_NUMBER" : 0
    } ]
    }
    

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
  "SALESDOCUMENT" : "0000073736",
  "EXTENSIONEX" : [ ],
  "EXTENSIONIN" : [ ],
  "ORDER_CCARD" : [ ],
  "ORDER_CFGS_BLOB" : [ ],
  "ORDER_CFGS_INST" : [ ],
  "ORDER_CFGS_PART_OF" : [ ],
  "ORDER_CFGS_REF" : [ ],
  "ORDER_CFGS_REFINST" : [ ],
  "ORDER_CFGS_VALUE" : [ ],
  "ORDER_CFGS_VK" : [ ],
  "ORDER_CONDITIONS_IN" : [ ],
  "ORDER_CONDITIONS_INX" : [ ],
  "ORDER_ITEMS_IN" : [ {
    "ITM_NUMBER" : 10,
    "HG_LV_ITEM" : 0,
    "MATERIAL" : "H18",
    "ALT_TO_ITM" : 0,
    "DLV_GROUP" : 0,
    "TARGET_QTY" : 1.0,
    "EX_RATE_FI" : 0.0,
    "ADD_VAL_DY" : 0,
    "EXCHG_RATE" : 0.0,
    "SALES_UNIT" : "EA",
    "TRG_QTY_NO" : 0.0,
    "TRGQTY_DEN" : 0.0,
    "RNDDLV_QTY" : 0.0,
    "MAXDEVAMNT" : 0.0,
    "MAXDEVPER" : 0.0,
    "MAXDEV_DAY" : 0.0,
    "OVERDLVTOL" : 0.0,
    "UNDDLV_TOL" : 0.0,
    "SALQTYNUM" : 0.0,
    "SALQTYDEN" : 0.0,
    "GROSS_WGHT" : 0.0,
    "NET_WEIGHT" : 0.0,
    "VOLUME" : 0.0,
    "DLV_PRIO" : 0,
    "ORDER_PROB" : 0,
    "MAX_PL_DLV" : 0.0,
    "COMP_QUANT" : 0.0,
    "TARGET_VAL" : 0.0,
    "DEPREC_PER" : 0.0,
    "REF_DOC_IT" : 0,
    "EXCH_RATE_FI_V" : 0.0,
    "EXCHG_RATE_V" : 0.0,
    "VAL_CON_I" : 0,
    "TP_BEGPER" : 0,
    "TP_ENDPER" : 0
  } ],
  "ORDER_ITEMS_INX" : [ {
    "ITM_NUMBER" : 0,
    "MATERIAL" : "X",
    "SALES_UNIT" : "X"
  } ],
  "ORDER_KEYS" : [ {
    "REFOBJECT" : "HEADER",
    "DOC_NUMBER" : "0000073736",
    "ITM_NUMBER" : 0,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 0,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "ADDRESS",
    "ITM_NUMBER" : 0,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 1,
    "ADDRESS" : "0000023206",
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "ITEM",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "STATUS" : "S",
    "TINDEX" : 1,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "SCHEDULE",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "STATUS" : "S",
    "TINDEX" : 1,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "SCHEDULE",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 1,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 0,
    "ABRLI" : 0
  } ],
  "ORDER_PARTNERS" : [ {
    "PARTN_ROLE" : "AG",
    "PARTN_NUMB" : "0000100018",
    "ITM_NUMBER" : 0
  } ],
  "ORDER_SCHEDULES_IN" : [ {
    "ITM_NUMBER" : 10,
    "SCHED_LINE" : 0,
    "REQ_QTY" : 1.0
  } ],
  "ORDER_SCHEDULES_INX" : [ {
    "ITM_NUMBER" : 10,
    "SCHED_LINE" : 1,
    "REQ_QTY" : "X"
  } ],
  "ORDER_TEXT" : [ ],
  "PARTNERADDRESSES" : [ ],
  "RETURN" : [ {
    "TYPE" : "S",
    "ID" : "V4",
    "NUMBER" : 233,
    "MESSAGE" : "SALES_HEADER_IN has been processed successfully",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAKKOM",
    "MESSAGE_V2" : "10.03.2016",
    "MESSAGE_V3" : "02:23:29",
    "PARAMETER" : "SALES_HEADER_IN",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "S",
    "ID" : "V4",
    "NUMBER" : 233,
    "MESSAGE" : "SALES_ITEM_IN has been processed successfully",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAPKOM",
    "MESSAGE_V2" : "000010",
    "PARAMETER" : "SALES_ITEM_IN",
    "ROW" : "1",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "W",
    "ID" : "V1",
    "NUMBER" : 555,
    "MESSAGE" : "The sales document is not yet complete: Edit data",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAPKOM",
    "MESSAGE_V2" : "000010",
    "PARAMETER" : "VBUVKOM",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "S",
    "ID" : "V1",
    "NUMBER" : 311,
    "MESSAGE" : "Standard Order 73736 has been saved",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "Standard Order",
    "MESSAGE_V2" : "73736",
    "PARAMETER" : "SALES_HEADER_IN",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  } ]
}

Create an ERP SD sales order using BAPI BAPI_SALESORDER_CREATEFROMDAT2

This is the second approach to the order creation. For the advantages of this approach, see Order Creation Details.

To create an ERP SD sales order using BAPI BAPI_SALESORDER_CREATEFROMDAT2, you need:

Request

  • Method: POST
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/createsdorder1
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_manage.
  • URI Parameters
    • {tenant}: The name of the current tenant
  • Body:
    {
    "INT_NUMBER_ASSIGNMENT" : "X",
    "ORDER_HEADER_IN" : {
      "DOC_TYPE" : "TA",
      "SALES_ORG" : "1000",
      "DISTR_CHAN" : "10",
      "DIVISION" : "10"
    },
    "ORDER_HEADER_INX" : {
      "UPDATEFLAG" : "I",
      "DOC_TYPE" : "X",
      "SALES_ORG" : "X",
      "DISTR_CHAN" : "X",
      "DIVISION" : "X"
    },
    "ORDER_ITEMS_IN" : [ {
      "ITM_NUMBER" : 10,
      "HG_LV_ITEM" : 0,
      "MATERIAL" : "H18",
      "TARGET_QTY" : 1.0,
      "SALES_UNIT" : "EA"
    } ],
    "ORDER_ITEMS_INX" : [ {
      "MATERIAL" : "X",
      "SALES_UNIT" : "X"
    } ],
    "ORDER_PARTNERS" : [ {
      "PARTN_ROLE" : "AG",
      "PARTN_NUMB" : "0000100018"
    } ],
    "ORDER_SCHEDULES_IN" : [ {
      "ITM_NUMBER" : 10,
      "REQ_QTY" : 1.0
    } ],
    "ORDER_SCHEDULES_INX" : [ {
      "ITM_NUMBER" : 10,
      "SCHED_LINE" : 1,
      "REQ_QTY" : "X"
    } ]
    }
    

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
  "SALESDOCUMENT" : "0000073736",
  "EXTENSIONEX" : [ ],
  "EXTENSIONIN" : [ ],
  "ORDER_CCARD" : [ ],
  "ORDER_CFGS_BLOB" : [ ],
  "ORDER_CFGS_INST" : [ ],
  "ORDER_CFGS_PART_OF" : [ ],
  "ORDER_CFGS_REF" : [ ],
  "ORDER_CFGS_REFINST" : [ ],
  "ORDER_CFGS_VALUE" : [ ],
  "ORDER_CFGS_VK" : [ ],
  "ORDER_CONDITIONS_IN" : [ ],
  "ORDER_CONDITIONS_INX" : [ ],
  "ORDER_ITEMS_IN" : [ {
    "ITM_NUMBER" : 10,
    "HG_LV_ITEM" : 0,
    "MATERIAL" : "H18",
    "ALT_TO_ITM" : 0,
    "DLV_GROUP" : 0,
    "TARGET_QTY" : 1.0,
    "EX_RATE_FI" : 0.0,
    "ADD_VAL_DY" : 0,
    "EXCHG_RATE" : 0.0,
    "SALES_UNIT" : "EA",
    "TRG_QTY_NO" : 0.0,
    "TRGQTY_DEN" : 0.0,
    "RNDDLV_QTY" : 0.0,
    "MAXDEVAMNT" : 0.0,
    "MAXDEVPER" : 0.0,
    "MAXDEV_DAY" : 0.0,
    "OVERDLVTOL" : 0.0,
    "UNDDLV_TOL" : 0.0,
    "SALQTYNUM" : 0.0,
    "SALQTYDEN" : 0.0,
    "GROSS_WGHT" : 0.0,
    "NET_WEIGHT" : 0.0,
    "VOLUME" : 0.0,
    "DLV_PRIO" : 0,
    "ORDER_PROB" : 0,
    "MAX_PL_DLV" : 0.0,
    "COMP_QUANT" : 0.0,
    "TARGET_VAL" : 0.0,
    "DEPREC_PER" : 0.0,
    "REF_DOC_IT" : 0,
    "EXCH_RATE_FI_V" : 0.0,
    "EXCHG_RATE_V" : 0.0,
    "VAL_CON_I" : 0,
    "TP_BEGPER" : 0,
    "TP_ENDPER" : 0
  } ],
  "ORDER_ITEMS_INX" : [ {
    "ITM_NUMBER" : 0,
    "MATERIAL" : "X",
    "SALES_UNIT" : "X"
  } ],
  "ORDER_KEYS" : [ {
    "REFOBJECT" : "HEADER",
    "DOC_NUMBER" : "0000073736",
    "ITM_NUMBER" : 0,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 0,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "ADDRESS",
    "ITM_NUMBER" : 0,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 1,
    "ADDRESS" : "0000023206",
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "ITEM",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "STATUS" : "S",
    "TINDEX" : 1,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "SCHEDULE",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 0,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "STATUS" : "S",
    "TINDEX" : 1,
    "ABRLI" : 0
  }, {
    "REFOBJECT" : "SCHEDULE",
    "ITM_NUMBER" : 10,
    "SCHED_LIN" : 1,
    "CONDITEMNO" : 0,
    "COND_ST_NO" : 0,
    "COND_COUNT" : 0,
    "TINDEX" : 0,
    "ABRLI" : 0
  } ],
  "ORDER_PARTNERS" : [ {
    "PARTN_ROLE" : "AG",
    "PARTN_NUMB" : "0000100018",
    "ITM_NUMBER" : 0
  } ],
  "ORDER_SCHEDULES_IN" : [ {
    "ITM_NUMBER" : 10,
    "SCHED_LINE" : 0,
    "REQ_QTY" : 1.0
  } ],
  "ORDER_SCHEDULES_INX" : [ {
    "ITM_NUMBER" : 10,
    "SCHED_LINE" : 1,
    "REQ_QTY" : "X"
  } ],
  "ORDER_TEXT" : [ ],
  "PARTNERADDRESSES" : [ ],
  "RETURN" : [ {
    "TYPE" : "S",
    "ID" : "V4",
    "NUMBER" : 233,
    "MESSAGE" : "SALES_HEADER_IN has been processed successfully",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAKKOM",
    "MESSAGE_V2" : "10.03.2016",
    "MESSAGE_V3" : "02:23:29",
    "PARAMETER" : "SALES_HEADER_IN",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "S",
    "ID" : "V4",
    "NUMBER" : 233,
    "MESSAGE" : "SALES_ITEM_IN has been processed successfully",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAPKOM",
    "MESSAGE_V2" : "000010",
    "PARAMETER" : "SALES_ITEM_IN",
    "ROW" : "1",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "W",
    "ID" : "V1",
    "NUMBER" : 555,
    "MESSAGE" : "The sales document is not yet complete: Edit data",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "VBAPKOM",
    "MESSAGE_V2" : "000010",
    "PARAMETER" : "VBUVKOM",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  }, {
    "TYPE" : "S",
    "ID" : "V1",
    "NUMBER" : 311,
    "MESSAGE" : "Standard Order 73736 has been saved",
    "LOG_MSG_NO" : 0,
    "MESSAGE_V1" : "Standard Order",
    "MESSAGE_V2" : "73736",
    "PARAMETER" : "SALES_HEADER_IN",
    "ROW" : "0",
    "SYSTEM" : "ERPCLNT167"
  } ]
}


Retrieve an ERP SD Sales Order

You can retrieve a specific ERP SD sales order to get the detailed information, such as customer's address, billing plan, business data, and so on.

Request

  • Method: GET
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/{salesorderId}
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_view.
  • URI Parameters
    • {tenant}: The name of the current tenant
    • {salesorderId}: The ERP Sales Order ID

You can use the following query parameters to influence the way the system returns your results:

  • qADDRESS: indicates whether to return a customer’s address
  • qBILLPLAN: indicates whether to return a billing plan
  • qBUSINESS: indicates whether to return business data
  • qCONFIGURE: indicates whether to return sales order configuration
  • qCONTRACT: indicates whether to return a contract
  • qCREDCARD: indicates whether to return credit card information
  • qFLOW: indicates whether to return a document flow
  • qHEADER: indicates whether to return header level data
  • qINCOMP_LOG: indicates whether to return the incompletion log
  • qITEM: indicates whether to return item level data
  • qPARTNER: indicates whether to return partner function information
  • qSDCOND: indicates whether to return sales order pricing condition
  • qSDCOND_ADD: indicates whether to return sales order pricing condition additional data
  • qSDSCHEDULE: indicates whether to return a schedule line
  • qSTATUS_H: indicates whether to return a header status
  • qSTATUS_I: indicates whether to return an item status
  • qTEXT: indicates whether to return text data

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
  "ORDER_ADDRESS_OUT": [
    {
      "ADDRESS": "0000023403",
      "ADDR_TYPE": "1",
      "CITY": "Saarbrücken",
      "COUNTRY": "DE",
      "COUNTRYISO": "DE",
      "DOC_NUMBER": "0000000001",
      "FORMOFADDR": "Company",
      "HOUSE_NO": 1420,
      "HOUSE_NO_LONG": "1420",
      "LANGU": "D",
      "LANGU_ISO": "DE",
      "NAME": "Inlandskunde DE 100 (SEPA)",
      "NAME_LIST": "Inlandskunde DE 100 (SEPA)",
      "OPERATION": "005",
      "POSTL_CODE": "66119",
      "REGION": "SL",
      "STREET": "Lohmeyerstraße",
      "STREETNA": "Lohmeyerstraße",
      "TELEPHONE": "09990 9821-0",
      "TRANSPZONE": "0000000002"
    }
  ],
  "ORDER_BUSINESS_OUT": [
    {
      "ACCNT_ASGN": "01",
      "ADD_VAL_DY": 0,
      "BILL_DATE": "2016-09-26",
      "CEPRPERCEN": 0,
      "CUST_GROUP": "01",
      "CUST_PO_NO": "POTESTEC",
      "EXCHG_RATE": 1,
      "EXCHG_RATE_V": 0,
      "EXCHRATECO": 0,
      "EXCHRATECO_V": 0,
      "EXCHRATEFI": 0,
      "EXCHRATELC": 0,
      "EXCHRATELC_V": 0,
      "EXCHRATEST": 1,
      "EXCHRATEST_V": 0,
      "EXCH_RATE_FI_V": 0,
      "FISC_YEAR": 0,
      "INCOTERMS1": "EXW",
      "INCOTERMS2": "Walldorf",
      "ITM_NUMBER": 0,
      "OPERATION": "005",
      "PAYMETHODE": "E",
      "PMNTTRMS": "SEPA",
      "POSTPERIOD": 0,
      "PRICE_DATE": "2016-09-26",
      "PURCH_NO_C": "potestEC",
      "SD_DOC": "0000000001",
      "SEPA_MANDATE_ID": "1010_10100100"
    }
  ],
  "ORDER_CONDITIONS_OUT": [
    {
      "ACCESS_SEQ": 40,
      "ACCOUNTKEY": "ERL",
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCLASS": "B",
      "CONDCNTRL": "A",
      "CONDCOINHD": 0,
      "CONDCOUNT": 1,
      "CONDFORMUL": 0,
      "CONDISMAND": "X",
      "CONDITIDX": 1,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDORIGIN": "A",
      "CONDVALUE": 175.5,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_NO": "0000006934",
      "COND_P_UNT": 1,
      "COND_ST_NO": 20,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "MAKMANENTR": "C",
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "QTYCONVERS": "X",
      "RATEOFCHA1": "X",
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_TYPE": "PPR0",
      "SD000COND_VALUE": 17.55,
      "SD000INDEX_NO": "2",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 2,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDSUBTOT": "1",
      "CONDVALUE": 175.5,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 100,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "PRINT_ID": "a",
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 17.55,
      "SD000INDEX_NO": "4",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 0,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDVALUE": 0,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 300,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 299,
      "FROREFSTEP": 101,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 0,
      "SD000INDEX_NO": "18",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 2,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDSUBTOT": "2",
      "CONDVALUE": 175.5,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 700,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "PRINT_ID": "a",
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 17.55,
      "SD000INDEX_NO": "19",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 2,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDSUBTOT": "3",
      "CONDVALUE": 175.5,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 800,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 17.55,
      "SD000INDEX_NO": "21",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 10,
      "ACCOUNTKEY": "MWS",
      "APPLICATIO": "V",
      "CALCTYPCON": "A",
      "CONBASEVAL": 175.5,
      "CONBASVAL": 0,
      "CONDCLASS": "D",
      "CONDCNTRL": "A",
      "CONDCOINHD": 0,
      "CONDCOUNT": 1,
      "CONDFORMUL": 0,
      "CONDITIDX": 1,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDORIGIN": "A",
      "CONDTYPE": "D",
      "CONDVALUE": 33.35,
      "COND_FORM": 16,
      "COND_FORM1": 0,
      "COND_NO": "0000006911",
      "COND_P_UNT": 0,
      "COND_ST_NO": 850,
      "CONEXCHRAT": 0,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "DENOMINATO": 0,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "GROUPCOND": "X",
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "MAKMANENTR": "D",
      "NUMCONVERT": 0,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "PRINT_ID": "A",
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_TYPE": "TTX1",
      "SD000COND_VALUE": 19,
      "SD000INDEX_NO": "22",
      "SD_DOC": "0000000001",
      "TAX_CODE": "A1"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 4,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDSUBTOT": "A",
      "CONDVALUE": 208.85,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 900,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 20.89,
      "SD000INDEX_NO": "24",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "A",
      "CONBASEVAL": 208.85,
      "CONBASVAL": 0,
      "CONDCLASS": "A",
      "CONDCNTRL": "A",
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 0,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDORIGIN": "A",
      "CONDTYPE": "E",
      "CONDVALUE": 0,
      "COND_FORM": 11,
      "COND_FORM1": 0,
      "COND_P_UNT": 0,
      "COND_ST_NO": 910,
      "CONEXCHRAT": 0,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "DENOMINATO": 0,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "MAKMANENTR": "D",
      "NUMCONVERT": 0,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_TYPE": "DCD1",
      "SD000COND_VALUE": 0,
      "SD000INDEX_NO": "25",
      "SD_DOC": "0000000001",
      "STAT_CON": "X"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCLASS": "B",
      "CONDCNTRL": "A",
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDCURREN": "EUR",
      "CONDFORMUL": 0,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 135,
      "CONDORIGIN": "A",
      "CONDSUBTOT": "B",
      "CONDTYPE": "G",
      "CONDVALUE": 135,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 930,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CORR_ISO": "EUR",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "MAKMANENTR": "D",
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "QTYCONVERS": "X",
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_TYPE": "PCIP",
      "SD000COND_VALUE": 13.5,
      "SD000INDEX_NO": "26",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001",
      "STAT_CON": "X"
    },
    {
      "ACCESS_SEQ": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONBASEVAL": 10,
      "CONBASVAL": 0,
      "CONDCOINHD": 0,
      "CONDCOUNT": 0,
      "CONDFORMUL": 11,
      "CONDITIDX": 0,
      "CONDIT_NO": "0000000001",
      "CONDIVALUE": 0,
      "CONDVALUE": 40.5,
      "COND_D_UNT": "ST",
      "COND_FORM": 0,
      "COND_FORM1": 0,
      "COND_P_UNT": 1,
      "COND_ST_NO": 950,
      "CONEXCHRAT": 1,
      "CONEXCHRAT_V": 0,
      "CONPRICDAT": "2016-09-26",
      "CURRENCISO": "EUR",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DENOMINATO": 1,
      "FACTBASVAL": 0,
      "FACTCONBAS": 0,
      "FROMREFSTE": 0,
      "FROREFSTEP": 0,
      "INCREASCAL": 0,
      "INCREMSCAL": 0,
      "INDEXNO": "0",
      "ITM_NUMBER": 10,
      "LEVEL_BOM": 0,
      "NUMCONVERT": 1,
      "OPERATION": "005",
      "PATH_BOM": 0,
      "ROUNDOFFDI": 0,
      "SCALBASVAL": 0,
      "SD000COND_COUNT": 1,
      "SD000COND_VALUE": 4.05,
      "SD000INDEX_NO": "27",
      "SD000T_UNIT_ISO": "PCE",
      "SDCURRENCY": "EUR",
      "SD_DOC": "0000000001"
    }
  ],
  "ORDER_COND_HEAD": [
    {
      "APPLICATIO": "V",
      "COND_NO": "0000006911",
      "COND_TYPE": "TTX1",
      "COND_USAGE": "A",
      "CREATED_BY": "BPINST",
      "CREAT_DATE": "2016-02-09",
      "ITM_NUMBER": 10,
      "OPERATION": "005",
      "SD_DOC": "0000000001",
      "TABLE_NO": "002",
      "VALID_FROM": "2016-02-09",
      "VALID_TO": "9999-12-31"
    },
    {
      "APPLICATIO": "V",
      "COND_NO": "0000006934",
      "COND_TYPE": "PPR0",
      "COND_USAGE": "A",
      "CREATED_BY": "BPINST",
      "CREAT_DATE": "2016-02-09",
      "ITM_NUMBER": 10,
      "OPERATION": "005",
      "SD_DOC": "0000000001",
      "TABLE_NO": "304",
      "VALID_FROM": "2016-02-09",
      "VALID_TO": "9999-12-31"
    }
  ],
  "ORDER_COND_ITEM": [
    {
      "ACCRUALS": 0,
      "ADD_VAL_DY": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "A",
      "CONDCURR": "%",
      "CONDITIDX": 1,
      "COND_COUNT": 1,
      "COND_NO": "0000006911",
      "COND_P_UNT": 0,
      "COND_TYPE": "TTX1",
      "COND_VALUE": 19,
      "CUMM_ACCR": 0,
      "CUM_VALUE": 0,
      "DENOMINATO": 0,
      "INCR_SCALE": 0,
      "ITM_NUMBER": 10,
      "LOWERLIMIT": 0,
      "MAXCONBAVA": 0,
      "MAXCONVAL": 0,
      "MINCONBAVA": 0,
      "NUMBORDERS": 0,
      "NUMCONVERT": 0,
      "OPERATION": "005",
      "PLAN_BASIS": 0,
      "PLCONDVAL": 0,
      "PRICSCALE": 0,
      "SCALETYPE": "A",
      "SCALE_QTY": 0,
      "SCALE_VAL": 0,
      "SD_DOC": "0000000001",
      "TAX_CODE": "A1",
      "UPPERLIMIT": 0
    },
    {
      "ACCRUALS": 0,
      "ADD_VAL_DY": 0,
      "APPLICATIO": "V",
      "CALCTYPCON": "C",
      "CONDCURR": "EUR",
      "CONDCURREN": "EUR",
      "CONDITIDX": 1,
      "COND_COUNT": 1,
      "COND_ISO": "EUR",
      "COND_NO": "0000006934",
      "COND_P_UNT": 1,
      "COND_TYPE": "PPR0",
      "COND_UNIT": "ST",
      "COND_VALUE": 17.55,
      "CONUNITISO": "PCE",
      "CUMM_ACCR": 0,
      "CUM_VALUE": 0,
      "CURRENCY": "EUR",
      "CURR_ISO": "EUR",
      "DENOMINATO": 0,
      "INCR_SCALE": 0,
      "ISOCURRENC": "EUR",
      "ITM_NUMBER": 10,
      "LOWERLIMIT": 0,
      "MAXCONBAVA": 0,
      "MAXCONVAL": 0,
      "MINCONBAVA": 0,
      "NUMBORDERS": 0,
      "NUMCONVERT": 0,
      "OPERATION": "005",
      "PLAN_BASIS": 0,
      "PLCONDVAL": 0,
      "PRICSCALE": 0,
      "SCALETYPE": "A",
      "SCALE_QTY": 0,
      "SCALE_VAL": 0,
      "SD_DOC": "0000000001",
      "UPPERLIMIT": 0
    }
  ],
  "ORDER_HEADERS_OUT": [
    {
      "ACC_PERIOD": 0,
      "COMP_CODE": "1010",
      "CONDITIONS": "0000000001",
      "CO_AREA": "A000",
      "CREATED_BY": "BPINST",
      "CRED_ACCNT": "0010100100",
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "CURR_CRED": "USD",
      "C_CTR_AREA": "A000",
      "DATE_TYPE": "1",
      "DISTR_CHAN": "10",
      "DIVISION": "00",
      "DOC_DATE": "2016-09-26",
      "DOC_NUMBER": "0000000001",
      "DOC_TYPE": "TA",
      "DUN_COUNT": 0,
      "HI_TYPE_PR": "A",
      "ISOCURRCRE": "USD",
      "ISOSTATCUR": "EUR",
      "KALSM_CH": "YB0001",
      "NET_VAL_HD": 175.5,
      "OPERATION": "005",
      "ORDBILLTYP": "F2",
      "ORD_PROBAB": 100,
      "PURCH_NO": "potestEC",
      "REC_DATE": "2016-09-26",
      "REC_TIME": "18:13:30",
      "REL_CREDIT": 0,
      "REQ_DATE_H": "2016-09-26",
      "SALES_ORG": "1010",
      "SD_DOC_CAT": "C",
      "SD_PRIC_PR": "Y10101",
      "SHIP_COND": "01",
      "SOLD_TO": "0010100100",
      "STAT_CURR": "EUR",
      "TELEPHONE": "09990 9821-0",
      "TRAN_GROUP": "0",
      "WBS_ELEM": 0
    }
  ],
  "ORDER_ITEMS_OUT": [
    {
      "ACCT_ASSGT": "01",
      "ACTCREDID": "X",
      "ALLOC_INDI": "1",
      "ALTERN_ITM": 0,
      "AVAILCHECK": "Y2",
      "BASE_UOM": "ST",
      "BATCH_EXIT": 0,
      "BOM_IT_NR": 0,
      "CASH_DISC": "X",
      "CAU_POSNR": 0,
      "CHCLASS_IN": 0,
      "COMPON_QTY": 0,
      "COND_P_UNT": 1,
      "COND_UNIT": "ST",
      "CONFIG": 0,
      "CONISOUNIT": "PCE",
      "CONV_FACT": 0,
      "COSTESTNR": 0,
      "COST_DOC_C": 135,
      "COUNTER": 0,
      "CREATED_BY": "BPINST",
      "CREAT_DATE": "2016-09-26",
      "CREDPRIC": 20.885,
      "CREDPRICIT": 20.89,
      "CR_EXCHRAT": 0.8,
      "CR_EXCHRAT_V": 1.25,
      "CUM_CF_QTY": 10,
      "CUM_CON_QU": 10,
      "CUM_REQ_DE": 10,
      "CURRENCY": "EUR",
      "CURREN_ISO": "EUR",
      "DIVISION": "00",
      "DLV_GROUP": 0,
      "DLV_PRIO": "02",
      "DOC_NUMBER": "0000000001",
      "EXCHRATEST_V": 0,
      "EXCH_RATE": 1,
      "FIX_SP_DAY": 0,
      "GROSS_VAL": 0,
      "GROSS_WEIG": 10,
      "GURANTEED": 0,
      "HG_LV_ITEM": 0,
      "INTCLASSNR": 0,
      "ISOCODUNIT": "PCE",
      "ITEM_CATEG": "TAN",
      "ITM_NUMBER": 10,
      "LOG_SYSTEM_OWN": "S4HCLNT300",
      "MATERIAL": "TG21",
      "MATL_GROUP": "L001",
      "MAT_ENTRD": "TG21",
      "MAX_DEVIAT": 0,
      "MAX_DEV_DA": 0,
      "MAX_DEV_PE": 0,
      "MAX_PL_DLV": 0,
      "MIN_DELY": 0,
      "MRP_AREA": "1010",
      "NET_PRICE": 17.55,
      "NET_VALUE": 175.5,
      "NET_WEIGHT": 9,
      "NO_OF_SERI": "0",
      "ORDER_PROB": 100,
      "OUT_AGR_TA": 0,
      "OVER_DLV_T": 0,
      "PLANT": "1010",
      "POSNR_VOR": 0,
      "PRICE_OK": "X",
      "PROFIT_CTR": "YB700",
      "PROFIT_SEG": 3,
      "REC_TIME": "18:14:07",
      "REL_FOR_BI": "A",
      "REQMTSTYP": "KSV",
      "REQ_QTY": 10,
      "ROUND_DLV": 0,
      "ROUTE": "TR0001",
      "SALES_QTY1": 1,
      "SALES_QTY2": 1,
      "SALES_UNIT": "ST",
      "SCALE_QUAN": 0,
      "SHIP_POINT": "1010",
      "SHORT_TEXT": "HAWA 21, Bestellpunkt, FIFO Charge",
      "STPOS_VBAP": 0,
      "SUBTOT_PP1": 175.5,
      "SUBTOT_PP2": 175.5,
      "SUBTOT_PP3": 175.5,
      "SUBTOT_PP4": 0,
      "SUBTOT_PP5": 0,
      "SUBTOT_PP6": 0,
      "TARGET_QTY": 0,
      "TARGET_QU": "ST",
      "TARG_QTY_D": 1,
      "TARG_QTY_N": 1,
      "TAX_AMOUNT": 33.35,
      "TAX_CLASS1": "1",
      "T_BAS_UNIT": "PCE",
      "T_UNIT_ISO": "PCE",
      "UNDER_DLV": 0,
      "UNIT_OF_WT": "G",
      "UNIT_WTISO": "GRM",
      "VALCONTRIT": 0,
      "VAR_SP_DAY": 0,
      "VOLUME": 0,
      "WBS_ELEM": 0
    }
  ],
  "ORDER_PARTNERS_OUT": [
    {
      "ADDRESS": "0000023403",
      "ADDRE_INDI": "D",
      "ASSIGN_HI": 0,
      "CONTACT": 0,
      "COUNTRY": "DE",
      "COUNTRYISO": "DE",
      "CUSTOMER": "0010100100",
      "ITM_NUMBER": 0,
      "LEVEL_NR": 0,
      "OPERATION": "005",
      "PARTN_ROLE": "AG",
      "PERSON_NO": 0,
      "SD_DOC": "0000000001",
      "TRANSPZONE": "0000000002"
    },
    {
      "ADDRESS": "0000023403",
      "ADDRE_INDI": "D",
      "ASSIGN_HI": 0,
      "CONTACT": 0,
      "COUNTRY": "DE",
      "COUNTRYISO": "DE",
      "CUSTOMER": "0010100100",
      "ITM_NUMBER": 0,
      "LEVEL_NR": 0,
      "OPERATION": "005",
      "PARTN_ROLE": "RE",
      "PERSON_NO": 0,
      "SD_DOC": "0000000001",
      "TRANSPZONE": "0000000002"
    },
    {
      "ADDRESS": "0000023403",
      "ADDRE_INDI": "D",
      "ASSIGN_HI": 0,
      "CONTACT": 0,
      "COUNTRY": "DE",
      "COUNTRYISO": "DE",
      "CUSTOMER": "0010100100",
      "ITM_NUMBER": 0,
      "LEVEL_NR": 0,
      "OPERATION": "005",
      "PARTN_ROLE": "RG",
      "PERSON_NO": 0,
      "SD_DOC": "0000000001",
      "TRANSPZONE": "0000000002"
    },
    {
      "ADDRESS": "0000023403",
      "ADDRE_INDI": "D",
      "ASSIGN_HI": 0,
      "CONTACT": 0,
      "COUNTRY": "DE",
      "COUNTRYISO": "DE",
      "CUSTOMER": "0010100100",
      "ITM_NUMBER": 0,
      "LEVEL_NR": 0,
      "OPERATION": "005",
      "PARTN_ROLE": "WE",
      "PERSON_NO": 0,
      "SD_DOC": "0000000001",
      "TRANSPZONE": "0000000002"
    }
  ],
  "ORDER_SCHEDULES_OUT": [
    {
      "AVAIL_CON": "X",
      "BASE_UOM": "ST",
      "BUSIITNR": 0,
      "COMMIT_QTY": 0,
      "CONFIR_QTY": 0,
      "CORR_QTY": 10,
      "DATE_TYPE": "1",
      "DOC_NUMBER": "0000000001",
      "FORCAST_NR": 0,
      "GI_DATE": "2016-09-27",
      "GRP_DEFIN": 0,
      "GURANTEED": 0,
      "ISOBASUNIT": "PCE",
      "ISOCODUNIT": "PCE",
      "ITM_NUMBER": 10,
      "LOAD_DATE": "2016-09-27",
      "MAINT_REQ": 0,
      "MOVE_TYPE": "601",
      "MS_DATE": "2016-09-26",
      "OPERATION": "005",
      "PREQ_ITEM": 0,
      "RELFORDEL": "X",
      "REQ_DATE": "2016-09-26",
      "REQ_QTY": 10,
      "REQ_QTY1": 0,
      "SALESQTYDE": 1,
      "SALESQTYNR": 1,
      "SALES_UNIT": "ST",
      "SCHED_LIN1": 0,
      "SCHED_LINE": 1,
      "SCHED_TYPE": "CV",
      "SIZE2": 0,
      "SIZE3": 0,
      "TP_DATE": "2016-09-27"
    },
    {
      "AVAIL_CON": "X",
      "BASE_UOM": "ST",
      "BUSIITNR": 0,
      "COMMIT_QTY": 0,
      "CONFIR_QTY": 10,
      "CORR_QTY": 0,
      "DATE_TYPE": "1",
      "DOC_NUMBER": "0000000001",
      "FORCAST_NR": 0,
      "GI_DATE": "2016-09-27",
      "GRP_DEFIN": 0,
      "GURANTEED": 0,
      "ISOBASUNIT": "PCE",
      "ISOCODUNIT": "PCE",
      "ITM_NUMBER": 10,
      "LOAD_DATE": "2016-09-27",
      "MAINT_REQ": 0,
      "MOVE_TYPE": "601",
      "MS_DATE": "2016-09-26",
      "OPERATION": "005",
      "PREQ_ITEM": 0,
      "RELFORDEL": "X",
      "REQ_DATE": "2016-09-28",
      "REQ_QTY": 0,
      "REQ_QTY1": 10,
      "SALESQTYDE": 1,
      "SALESQTYNR": 1,
      "SALES_UNIT": "ST",
      "SCHED_LIN1": 0,
      "SCHED_LINE": 2,
      "SCHED_TYPE": "CV",
      "SIZE2": 0,
      "SIZE3": 0,
      "TP_DATE": "2016-09-27"
    }
  ],
  "ORDER_STATUSHEADERS_OUT": [
    {
      "CONFIRSTAT": "C",
      "DELIV_STAT": "A",
      "DLV_STAT_H": "A",
      "DOCIMCOMPR": "C",
      "GENINCOMHD": "C",
      "HDIMCOMDEL": "C",
      "HDINCOMBIL": "C",
      "OVERALLREJ": "A",
      "PRC_STAT_H": "A",
      "SDDOCOBJ": "A",
      "SD_DOC": "0000000001",
      "SD_DOC_CAT": "C",
      "TOTINCOMBI": "C",
      "TOTINCOMIT": "C",
      "TOTINCOMPL": "C"
    }
  ],
  "ORDER_STATUSITEMS_OUT": [
    {
      "CONFSTATIT": "C",
      "DELIV_STAT": "A",
      "DLV_STAT_I": "A",
      "GENINCOMST": "C",
      "INCOMSTBIL": "C",
      "INCOMSTDEL": "C",
      "INCOMSTPRI": "C",
      "ITM_NUMBER": 10,
      "OVRPROCSTA": "A",
      "REJSTATIT": "A",
      "SD_DOC": "0000000001"
    }
  ],
  "SALES_DOCUMENTS": [
    {
      "VBELN": "0000000001"
    }
  ]
}


Update an ERP SD Sales Order

You can update a specific ERP SD sales order to change the relevant information, such as purchase order number, delivery block, partner's address, and so on.

Use the following example to change the purchase number of an ERP SD sales order.

Request

  • Method: PUT
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/erpsalesorder/{salesorderId}
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_manage.
  • URI Parameters
    • {tenant}: The name of the current tenant
    • {salesorderId}: The ERP Sales Order ID
  • Body:
    {
      "ORDER_HEADER_IN" : {
      "PURCH_NO_C" : "testPO"
      },
      "ORDER_HEADER_INX" : {
       "UPDATEFLAG" : "U",
       "PURCH_NO_C" : "X"
      },
      "SALESDOCUMENT" : "0000000001",
      "SIMULATION" : "X"
    }
    

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
  {
    "ID": "V4",
    "LOG_MSG_NO": 0,
    "MESSAGE": "ORDER_HEADER_IN has been processed successfully",
    "MESSAGE_V1": "VBAKKOM",
    "MESSAGE_V2": "A000",
    "NUMBER": 233,
    "PARAMETER": "ORDER_HEADER_IN",
    "ROW": "0",
    "SYSTEM": "S4HCLNT300",
    "TYPE": "S"
  }
]


Retrieve Help Values for a Single Field

To retrieve help values for a single field, you need:

Request

  • Method: GET
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/helpvalues
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_view.
  • URI Parameters
    • {tenant}: The name of the current tenant
  • Query Parameters
    • FieldName: The field name, for which you get the help values.

Use this example to get help values for the field Payment Terms (ZTERM).

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
    {
        "language": "en",
        "key":"NT00",
        "value":"Payable upon receipt"
    },
    {
         "language": "en",
        "key":"NT30",
        "value":"Net due in 30 days"
    }
]


Retrieve Help Values for Multiple Fields

To retrieve help values for multiple fields, you need:

Request

  • Method: GET
  • Request URL: https://api.beta.yaas.io/hybris/sdorderproxy/v1/{tenant}/multiplehelpvalues
  • Headers
    • Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.sdorderproxy_view.
  • URI Parameters
    • {tenant}: The name of the current tenant
  • Query Parameters
    • FieldName: Names of the fields, for which you get the help values. Use a comma to separate multiple fields.

Use this example to get help values for both Payment Terms (ZTERM) and Payment Method (ZLSCH).

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
  {
    "OutputOfHelpValue": [
      {
        "language": "E"
      },
      {
        "key": "0001",
        "language": "E",
        "value": "Pay immediately w/o deduction"
      },
      {
        "key": "0002",
        "language": "E",
        "value": "14 days 2%, 30 net"
      },
      {
        "key": "0003",
        "language": "E",
        "value": "14 days 3%, 20/2%, 30 net"
      },
      {
        "key": "0004",
        "language": "E",
        "value": "as of end of month"
      },
      {
        "key": "0005",
        "language": "E",
        "value": "from the 10th of subs. month"
      },
      {
        "key": "0006",
        "language": "E",
        "value": "End of month 4%, Mid-month 2%"
      },
      {
        "key": "0007",
        "language": "E",
        "value": "15th/31st subs. month 2%, ..."
      },
      {
        "key": "0008",
        "language": "E",
        "value": "14 days 2%, 30/1,5%, 45 net"
      },
      {
        "key": "0009",
        "language": "E",
        "value": "Payable in 3 installments"
      },
      {
        "key": "IK00",
        "language": "E",
        "value": "Within 5 days 3% cash discount"
      },
      {
        "key": "LVT0",
        "language": "E",
        "value": "16 days 2%, 31 days net"
      },
      {
        "key": "MVT0",
        "language": "E",
        "value": "10 days 3%, 16  2%, 31 net"
      },
      {
        "key": "NT00",
        "language": "E",
        "value": "Payable upon receipt"
      },
      {
        "key": "NT08",
        "language": "E",
        "value": "Net due in 8 days"
      },
      {
        "key": "NT15",
        "language": "E",
        "value": "Net due in 15 days"
      },
      {
        "key": "NT30",
        "language": "E",
        "value": "Net due in 30 days"
      },
      {
        "key": "NT45",
        "language": "E",
        "value": "Net due in 45 days"
      },
      {
        "key": "NT60",
        "language": "E",
        "value": "Net due in 60 days"
      },
      {
        "key": "SEPA",
        "language": "E",
        "value": "SEPA Direct Debit"
      },
      {
        "key": "WALL",
        "language": "E",
        "value": "99% forever"
      },
      {
        "key": "WL01",
        "language": "E",
        "value": "12 days net"
      },
      {
        "key": "ZB00",
        "language": "E",
        "value": "Pay immediately w/o deduction"
      },
      {
        "key": "ZB01",
        "language": "E",
        "value": "14 Days 3%, 30/2%, 45 net"
      },
      {
        "key": "ZB02",
        "language": "E",
        "value": "8 days 5%, 14/2%, 21 net"
      },
      {
        "key": "ZB03",
        "language": "E",
        "value": "20 days 2%, 30 days net"
      },
      {
        "key": "ZB04",
        "language": "E",
        "value": "10 days 4%, 20/2%, 30 net"
      },
      {
        "key": "ZB05",
        "language": "E",
        "value": "5 days 2%, 10 days net"
      }
    ],
    "fieldname": "ZTERM"
  },
  {
    "OutputOfHelpValue": [
      {
        "key": "F",
        "language": "E",
        "value": "Foreign bank transfer (DTAZV)"
      },
      {
        "key": "I",
        "language": "E",
        "value": "ISO PAIN001: Credit Transfer"
      },
      {
        "key": "T",
        "language": "E",
        "value": "SEPA Credit Transfer"
      },
      {
        "key": "E",
        "language": "E",
        "value": "Direct Debit"
      },
      {
        "key": "C",
        "language": "E",
        "value": "Check"
      },
      {
        "key": "D",
        "language": "E",
        "value": "Bank transfer (ACH CCD)"
      },
      {
        "key": "I",
        "language": "E",
        "value": "ISO PAIN.001 Credit Transfer"
      },
      {
        "key": "P",
        "language": "E",
        "value": "Bank transfer (ACH PPD)"
      },
      {
        "key": "T",
        "language": "E",
        "value": "Bank transfer (ACH CTX)"
      }
    ],
    "fieldname": "ZLSCH"
  }
]


Error Types

For information about error codes, see the API Reference.


Glossary

TermDescription
help valueAn allowed value for an input field.


  • Send feedback

    If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.

  • Get Help

    Use our private help channel. Receive updates over email and contact our specialists directly.

  • hybris Experts

    If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.