Skip to content

Endpoints꞉ My Items

mindfulsoftware edited this page Jun 4, 2019 · 1 revision

Endpoints

Endpoint Verb Paging Description
/api/my-items GET Y returns all items
/api/my-items/{id} GET returns items for a given Id
/api/my-items POST create new items
/api/my-items PUT updates existing items
/api/my-items/{id} DELETE deletes an item for a given Id

Objects

My-Item Request

{
    "code": "",
    "name": "",
    "weightDead": 0,
    "length": 0,
    "width": 0,
    "height": 0
}

My-Item Response

{
    "myItemId": 0,
    "code": "",
    "name": "",
    "description": "",
    "weightDead": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "weightCubic": 0.1,
    "version": "AAAAAAAHnIY="
}

description - (read only) A description derived from the weight and dimensions provided

weightCubic - (read only) The calculated cubic weight of the package from the length, width and height dimensions

version - (read only) This stamp is used to determine whether the object has been updated by another user. This field is require for updates (PUT)