Table of Contents

Public API

The Public API of shippingNET is a state-of-the-art web API in REST architecture ("Representational State Transfer").

Prerequisites

  1. A shippingNET system.
  2. Configuration of the organizational structure with stored business partner number (BusinessPartnerNumber). See also: Create Organization.
  3. Postman to send sample requests (Free tool: https://www.postman.com/downloads/).
  4. Credentials for authentication of requests.

Get credentials

  1. In the main view, navigate to the System Configuration menu item.
  2. In the Organization section, click on the API sub-item.
  3. In the Credentials section, you will find the parameters for authentication:

All you need is the api-key: This is a compound key that combines the ClientID, OrgUnitID and OrgUnitGUID.

Example request for article creation with Postman

To import item data, proceed as follows.

  1. In the main view, navigate to the menu item System Configuration.
  2. In the Organization section, click on the API sub-item.
  3. In the APIs section, click Article in the list of available APIs.
  4. You will now see the documentation for the Article API with the available methods and their request structure. Article API
  5. Click on the Download action and save the OpenAPI specification for the article service locally to your PC.
  6. Open the Postman program and import the file. To do this, click on the Import action under Workspaces/My Workspace in Postman and select the file.
  7. Now enter the credentials in the shippingNET PublicApi Article Service collection. For versions prior to 24.1.0.0, set the client-id, orgunit-id, and auth-token values under Variables. As of version 24.1.0.0, you only set the apiKey under Variables.
  8. Edit the request under the Body tab and enter the desired item information. See also Article Fields.
  9. Finally, click on the Send action to the right of the address to perform the import.
Tip

Start with a minimal set of fields and gradually expand the data to be transferred!

Tip

Some fields require codes or IDs to be passed. These values are related to the activation of various master data in the system configuration. The list of codes and their meaning can be found in the System Configuration in the Organization section in the API subitem. In the Description section, click on Shipment Overview.

If the request is successful (status code 200), the fields requested in the body will be returned.

'''json: { "Article": { "ID": "", "Number": "", "CustomerBusinessPartnerNumber": "" } } '''

In the event of an error (status code 500), you will receive the cause of the error in the following form:

'''json: { "ExceptionCode": "", "ExceptionType": "", "ExceptionMessage": "", "Source": "" } '''