Open Inventory / Docs
EndpointsScan workflowsStockScan workflowsWorkflowid

Retrieve one stock scan workflow

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

GET
/stock/scan-workflows/{workflowId}

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

workflowId*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Scan workflow

application/json
  1. response
workflow*
Example Request
curl -X GET 'https://inventory.example.com/api/v1/stock/scan-workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "workflow": {    "actions": [],    "oncePerCode": false,    "name": "string",    "description": "",    "enabled": true,    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "codeTypes": [      "qr_code",      "data_matrix",      "aztec",      "pdf417",      "code_128",      "code_93",      "code_39",      "codabar",      "ean_13",      "ean_8",      "upc_a",      "upc_e",      "itf"    ],    "publicTriggerEnabled": false,    "publicTriggerCode": "string",    "quantityInputKey": "string",    "extraction": {      "mode": "full"    },    "identifierPropertyKey": "string",    "identifierStorage": "custom-field",    "extractedFields": [],    "operation": {      "type": "unit"    },    "createMissingUnit": false,    "unitStatus": "available",    "fixedProperties": [      {        "key": "string",        "label": "string",        "value": "string",        "storage": "custom-field"      }    ],    "inputFields": [      {        "visibleWhen": {          "mode": "all",          "rules": [            {              "left": {                "source": "literal",                "value": "string"              },              "operator": "equals",              "right": {                "source": "literal",                "value": "string"              }            }          ]        },        "key": "string",        "label": "string",        "required": true,        "type": "text",        "storage": "custom-field",        "placeholder": "",        "options": []      }    ],    "triggerWebhook": false,    "webhookEventName": "inventory.action.executed",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "publicTriggerId": "df54c35d-9bab-440a-ba65-bab9b848a308",    "revision": 1,    "createdBy": "string",    "updatedBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}