Web API Response
The Web API sends a response to let you know the status of each entry submitted.
This Solution provides an example. (6531)
The Web API sends a response to let you know the status of each entry submitted.
This example is a Sales Order Line Item (SOLI) Import called "test" (see the escaped url on line 2). It successfully created Sales Order Numbers 8566 and 8567 (SONo on lines 8 and 16). It failed to create the third.
"id" is the submitted name/value that is mapped to Customer PO # or Order # (required to identify each order). If your request maps "web_order" the reply will contain "web_order".
"status" is the result of the nested transaction that handles each object--in this case an order. When the result is "Success" the response includes additional results--a unique id (UID), Sales Order Number (SONo), Customer Listing (CustLisg), and Total (Ttl). When the result is "Failure" there are no additional results.
"exceptions" are included where they occur--in the response or within objects.
"source" is the name and number of a Solution that explains where the exception comes from. With thousands of possible exceptions this is an import part to know first.
"text" is the exception message, including any error code [in brackets] and message--in this case what displays in an alert when an import cannot find an item to use.
Web API Import Settings
The Web API Import Settings use the standard Import Settings with a few additions:
• Fields/Notes lets you enter a list of Fields Available for Insertion and any Notes
• Fields/Notes lets you Paste sample JSON or XML to extract Fields automatically
• Fields Available for Insertion are listed in Xpath notation
• Web API Imports should be saved with a web-friendly name
This Solution provides details. (6531)
The Web API Import Settings use the standard Import Settings with a few additions:
• Fields/Notes lets you enter a list of Fields Available for Insertion and any Notes
• Fields/Notes lets you Paste sample JSON or XML to extract Fields automatically
• Fields Available for Insertion are listed in Xpath notation
• Web API Imports should be saved with a web-friendly name
To Create a New Web API Import:
1. Click the Web API tool on the Maintenance toolbar
2. Click the Fields/Notes button, paste sample JSON or a field list, and click OK
3. Map the Fields Available to Insertion Order by selecting and clicking Insert
4. Click Save As... to name and save the Import using a web-friendly name
Fields/Notes lets you Paste a sample JSON or XML file to extract Fields Available for Insertion. These are listed in Xpath notation like "/line_items/item/code". You can ignore repeat entries with counters ("/line_items/item[2]/code") unless specifically needed.
When you save your API Import its endpoint uses its web-friendly name. If you name your API Import, "test", it is available at "https://server_address:port/api/import/test". If you Post JSON matching your sample, it will be mapped and imported using the settings saved in "test". And "test" will be listed in the Web API tool if you need to make more changes.
Web API
Web API provides a REST API you can use from another application, like Magento, to send Orders to Big Business.
This Solution provides details. (6810)
Web API is an Option for Big Business Enterprise thet provides a REST API for sending Orders to Big Business.
Setup includes Mapping for order information.