younifyd
Menu

/api/items (Execute item action)

Execute item action

POST/api/items

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/items (Execute item action) action (under ItemController).
  3. Fill in the fields below, then reference the result from later steps as {{apiItemsExecuteItemAction.response.data}}.

Request

Query parameters

actionstringrequired

One ofNONEREFRESH_ITEMSAMENDEDITEDIT_CANCELSAVELOAD_DOCSAVE_AND_CONFIRMLOAD_VIEW_DEFINITIONDONE_DOCSEND_TO_VENDORSEND_TO_BUYERMARK_AS_OUT_OF_SIGNATUREMARK_AS_SIGNEDSEND_REMINDER_TO_VENDORSUBMITSET_TO_ACTIVESET_TO_INACTIVESET_TO_CANCELEDSET_AS_DEFAULTMARK_AS_CONCEPTMARK_AS_COSTINGMARK_AS_ADOPTEDMARK_AS_FINALIZEDMARK_AS_QUOTEDMARK_AS_SHORTLISTEDREMOVE_FROM_SHORTLISTMARK_AS_CONFIRMTOBUYMARK_AS_REJECTTOBUYMARK_AS_REVISEMARK_AS_PROPOSEDMARK_AS_OVERRIDDENMARK_AS_SOURCINGMARK_AS_PHASE_1_TRACKING_COMPLETEDMARK_AS_DRAFTMARK_AS_OFFICIALMARK_AS_READY_FOR_ONBOARDINGMARK_AS_CONFIRMEDMARK_AS_DEFAULTMARK_AS_SUBMITTED

approvalTemplateIdstring
skipVersionboolean

Default false

asyncIndexboolean

Default false

Request body

Enter the body as JSON in the step's Body field.

versioninteger (int32)
refNostring
itemNostring
itemNamestring
itemDescstring
masterEanstring
buyerItemNostring
masterCasePackinteger (int32)
eanTypeobject
codestringrequired
namestring
versioninteger (int32)
customFieldsobject
dynamicModelMapobject
json
{
  "version": 0,
  "refNo": "string",
  "itemNo": "string",
  "itemName": "string",
  "itemDesc": "string",
  "masterEan": "string",
  "buyerItemNo": "string",
  "masterCasePack": 0,
  "eanType": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "customFields": {
    "dynamicModelMap": {}
  }
}

Response

Returns 200 with an object. Read it in later steps with {{apiItemsExecuteItemAction.response.data.<field>}}.

versioninteger (int32)
refNostring
itemNostring
itemNamestring
itemDescstring
masterEanstring
buyerItemNostring
masterCasePackinteger (int32)
eanTypeobject
codestringrequired
namestring
versioninteger (int32)
customFieldsobject
dynamicModelMapobject
json
{
  "version": 0,
  "refNo": "string",
  "itemNo": "string",
  "itemName": "string",
  "itemDesc": "string",
  "masterEan": "string",
  "buyerItemNo": "string",
  "masterCasePack": 0,
  "eanType": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "customFields": {
    "dynamicModelMap": {}
  }
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.