Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

With the Nexus card ordering API, you can build in card ordering functions into your own application. This article provides an example instruction for a typical card ordering workflow. 

For more information, see Card ordering API details


Example: Place card order via the card ordering API

 Log in to ordering portal

To send an order, or get information from the ordering portal, you first need to log in. If the login is successful, the result includes a bearer token to be used in other commands.

  1. Log in with your supplied credentials to get a bearer token. 

    Example: Log in
    POST /login
    {
    	"username": "string"
    	"password": "string"
    }
 Get layout options

If you want to see the options for layouts and accessories, follow these steps:

  1. To view a list of available layouts for your company: 

    Example: View layout options
    GET /layout
    {
      "foundCount": 0,
      "layouts": [
        {
          "layoutId": 0,
          "layoutName": "string",
          "description": "string"
        }
      ]
    }
  2. To view layout fields for a specific layout: 

    Example: Layout fields
    GET /layout{id}
    {
      "layoutId": 0,
      "layoutName": "string",
      "articlesIncluded": [
        {
          "artId": "CH3301-S",
          "name": "Card Holder EC Standard - Black",
          "description": "Card holder for one card with clip on back. The clip is easily removed and then holds two cards. One side is open for convenient card access",
          "imageUrl": "https://web.nexusonlineservices.com/Bilder/Artikel/1300.jpg"
        }
      ],
      "inputFields": [
        {
          "name": "string",
          "label": "string",
          "type": "string",
          "required": true,
          "maxLength": 0,
          "valueList": [
            {
              "index": "Accepted value for \"name\"",
              "label": "Explanation of index"
            }
          ]
        }
      ]
    }
  3. To view a list of available accessories:

    Example: View accessories options
    GET /accessories
    {
      "artId": "CH3301-S",
      "name": "Card Holder EC Standard - Black",
      "description": "Card holder for one card with clip on back. The clip is easily removed and then holds two cards. One side is open for convenient card access",
      "imageUrl": "https://web.nexusonlineservices.com/Bilder/Artikel/1300.jpg"
    }
 Send order
  1. Post the order. Include specification of layout fields and accessories:

    Example: Send order
    POST /order
    {
      "layoutId": 0,
      "inputField": "input value",
      "accessories": [
        {
          "artId": "CH3301-S",
          "amount": 0
        }
      ]
    }



  • No labels