Skip to main content

Stock Engine Integration Configurations

The authentication features of the service to be integrated must be set to “auth” along side the full URL address of the service, and the mode of operation (single – plural query) must be set in the “service” field.

Authentication​

Authentication types supported by OMS Stock Integration services:

  1. Anonymous
  2. Basic Auth
  3. Token Auth

Example of a service integration configuration that does not require authentication, and responds directly to GET requests:

{
    "auth": {
        "type": "anonymous"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}

Integration settings that require Basic Authentication:

{
    "auth": {
        "type": "basic_auth",
        "username": "XXXXXX",
        "password": "YYYYYY"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}

Integration settings that require Token Authentication:

{
    "auth": {
        "type": "token",
        "url": "https://yourdomain.com/authentication/service/",
        "username": "XXXXX",
        "password": "YYYYY"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}

Service​

The return scheme of the service you will integrate is prepared depending on which of the multiple- or single-stock query methods was used. Examples include:

  1. Multiple-Stock Query: “multiple” (RECOMMENDED)
  2. Single-Stock Query: “single”

type information must be specified in the “service” setting group.

The settings of the integration that will enable the OMS to learn the stock status of all SKUs in the correct order with a single request:

{
    "auth": {...},
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"multiple"
    }
}

Integration settings (single) that must be prepared in case the OMS is required to issue separate requests for each different SKU in the order to be planned:

{
    "auth": {...},
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"single"
    }
}

inventoryEngine.md Displaying inventoryEngine.md.