Inventory Transfer

WIP: A summary needs to be written for Inventory Transfer

GET/v3/inventory_transfer/:transferId/item

Find Many Transfer Items

Returns a list of items for the specified inventory transfer

URL parameters

  • Name
    transferId
    Type
    string Required
    Description
    the id for the inventory transfer

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    array Required
    Description
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

  • Name
    hasMore
    Type
    boolean
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number
    Description
    the total number of records

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_transfer/:transferId/item
curl https://api.shopmonkey.cloud/v3/inventory_transfer/TRANSFERID/item \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "companyId": "companyId",
      "createdDate": "createdDate",
      "updatedDate": null,
      "transferId": "transferId",
      "inventoryPartId": null,
      "inventoryTireId": null,
      "name": null,
      "sku": null,
      "retailCostCents": null,
      "wholesaleCostCents": null,
      "quantity": 1
    }
  ],
  "success": true
}
POST/v3/inventory_transfer/:transferId/item

Create Transfer Item

MISSING description

URL parameters

  • Name
    transferId
    Type
    string Required
    Description
    the id for the inventory transfer

Body parameters

Consumes

The following content type is required: application/json

  • Name
    inventoryPartId
    Type
    string
    Description
    the id for the inventory part at the fromLocationId of the transfer
  • Name
    inventoryTireId
    Type
    string
    Description
    the id for the inventory tire at the fromLocationId of the transfer
  • Name
    quantity
    Type
    number Required
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryTransferItem schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    transferId
    Type
    string Required
    Description
  • Name
    inventoryPartId
    Type
    string Required
    Description
    related to the fromLocationId's inventory parts
  • Name
    inventoryTireId
    Type
    string Required
    Description
    related to the fromLocationId's inventory tires
  • Name
    name
    Type
    string Required
    Description
    Saved at the time of the transfer so that inventory names can change but the transfer name is locked in time
  • Name
    sku
    Type
    string Required
    Description
    Saved at the time of the transfer so that inventory skus can change but the transfer sku is locked in time
  • Name
    retailCostCents
    Type
    integer Required
    Description
    Saved at the time of the transfer so that inventory prices can change but the transfer price is locked in time
  • Name
    wholesaleCostCents
    Type
    integer Required
    Description
    Saved at the time of the transfer so that inventory prices can change but the transfer price is locked in time
  • Name
    quantity
    Type
    integer Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_transfer/:transferId/item
curl https://api.shopmonkey.cloud/v3/inventory_transfer/TRANSFERID/item \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{ "quantity" : 0 }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "companyId": "companyId",
    "createdDate": "createdDate",
    "updatedDate": null,
    "transferId": "transferId",
    "inventoryPartId": null,
    "inventoryTireId": null,
    "name": null,
    "sku": null,
    "retailCostCents": null,
    "wholesaleCostCents": null,
    "quantity": 1
  }
}
PUT/v3/inventory_transfer/:transferId/item/:itemId

Update Transfer Item

MISSING description

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inventory transfer item
  • Name
    transferId
    Type
    string Required
    Description
    the id for the inventory transfer

Body parameters

Consumes

The following content type is required: application/json

  • Name
    inventoryPartId
    Type
    string
    Description
    the id for the inventory part at the fromLocationId of the transfer
  • Name
    inventoryTireId
    Type
    string
    Description
    the id for the inventory tire at the fromLocationId of the transfer
  • Name
    quantity
    Type
    number
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryTransferItem schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    transferId
    Type
    string Required
    Description
  • Name
    inventoryPartId
    Type
    string Required
    Description
    related to the fromLocationId's inventory parts
  • Name
    inventoryTireId
    Type
    string Required
    Description
    related to the fromLocationId's inventory tires
  • Name
    name
    Type
    string Required
    Description
    Saved at the time of the transfer so that inventory names can change but the transfer name is locked in time
  • Name
    sku
    Type
    string Required
    Description
    Saved at the time of the transfer so that inventory skus can change but the transfer sku is locked in time
  • Name
    retailCostCents
    Type
    integer Required
    Description
    Saved at the time of the transfer so that inventory prices can change but the transfer price is locked in time
  • Name
    wholesaleCostCents
    Type
    integer Required
    Description
    Saved at the time of the transfer so that inventory prices can change but the transfer price is locked in time
  • Name
    quantity
    Type
    integer Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inventory_transfer/:transferId/item/:itemId
curl https://api.shopmonkey.cloud/v3/inventory_transfer/TRANSFERID/item/ITEMID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PUT -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "companyId": "companyId",
    "createdDate": "createdDate",
    "updatedDate": null,
    "transferId": "transferId",
    "inventoryPartId": null,
    "inventoryTireId": null,
    "name": null,
    "sku": null,
    "retailCostCents": null,
    "wholesaleCostCents": null,
    "quantity": 1
  }
}
DELETE/v3/inventory_transfer/:transferId/item/:itemId

Delete Transfer Item

MISSING description

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inventory transfer item
  • Name
    transferId
    Type
    string Required
    Description
    the id for the inventory transfer

Produces

The response content type: application/json

200 Response

  • Name
    success
    Type
    boolean Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inventory_transfer/:transferId/item/:itemId
curl https://api.shopmonkey.cloud/v3/inventory_transfer/TRANSFERID/item/ITEMID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X DELETE -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true
}
GET/v3/inventory_transfer/:id

Find

Find one by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to retrieve

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object Required
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied Required
    Description
  • Name
    totalCount
    Type
    integer Required
    Description
    the total count of all the items in the transfer
  • Name
    totalRetailCostCents
    Type
    integer Required
    Description
    the total cost of all the items in the transfer
  • Name
    totalWholesaleCostCents
    Type
    integer Required
    Description
    the total wholesale cost of all the items in the transfer
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    items
    Type
    array Required
    Description

Properties for meta object

  • Name
    userId
    Type
    string
    Description
    the user id that made the most recent change
  • Name
    sessionId
    Type
    string
    Description
    the session id for the most recent change
  • Name
    version
    Type
    number
    Description
    a monotonically increasing number for the most recent change

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_transfer/:id
curl https://api.shopmonkey.cloud/v3/inventory_transfer/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "id": "id",
    "companyId": "companyId",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "number": 1,
    "fromLocationId": null,
    "toLocationId": null,
    "orderId": null,
    "note": "note",
    "status": "status",
    "totalCount": 1,
    "totalRetailCostCents": 1,
    "totalWholesaleCostCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "items": [
      {
        "id": "id",
        "retailCostCents": null,
        "wholesaleCostCents": null,
        "quantity": 1,
        "inventoryPart": {
          "id": "id",
          "name": "name",
          "availableQuantity": 1,
          "sku": null,
          "normalizedSKU": null,
          "retailCostCents": 1,
          "wholesaleCostCents": null
        },
        "inventoryTire": {
          "id": "id",
          "name": "name",
          "availableQuantity": 1,
          "retailCostCents": 1,
          "wholesaleCostCents": null,
          "sku": null,
          "normalizedSKU": null
        }
      }
    ]
  },
  "success": true
}
POST/v3/inventory_transfer/search

Search entities

Search for Entries

Body parameters

Consumes

The following content type is required: application/json

  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderBy
    Type
    one of: any, any
    Description
    the order instructions for the result
  • Name
    params
    Type
    undefined
    Description
    additonal request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    one of: any, any
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
    an array of items
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_transfer/search
curl https://api.shopmonkey.cloud/v3/inventory_transfer/search \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "companyId": "companyId",
      "createdDate": "createdDate",
      "updatedDate": null,
      "number": 1,
      "fromLocationId": null,
      "toLocationId": null,
      "orderId": null,
      "note": "note",
      "status": "status",
      "totalCount": 1,
      "totalRetailCostCents": 1,
      "totalWholesaleCostCents": 1,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "order": {
        "id": "id",
        "companyId": "companyId",
        "locationId": "locationId",
        "number": "number",
        "coalescedName": null
      }
    }
  ],
  "success": true
}
POST/v3/inventory_transfer

Create

Create an

Body parameters

Consumes

The following content type is required: application/json

  • Name
    fromLocationId
    Type
    string
    Description
  • Name
    toLocationId
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied
    Description
  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    companyId
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryTransfer schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied Required
    Description
  • Name
    totalCount
    Type
    integer Required
    Description
    the total count of all the items in the transfer
  • Name
    totalRetailCostCents
    Type
    integer Required
    Description
    the total cost of all the items in the transfer
  • Name
    totalWholesaleCostCents
    Type
    integer Required
    Description
    the total wholesale cost of all the items in the transfer
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_transfer
curl https://api.shopmonkey.cloud/v3/inventory_transfer \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "companyId": "companyId",
    "createdDate": "createdDate",
    "updatedDate": null,
    "number": 1,
    "fromLocationId": null,
    "toLocationId": null,
    "orderId": null,
    "note": "note",
    "status": "status",
    "totalCount": 1,
    "totalRetailCostCents": 1,
    "totalWholesaleCostCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  }
}
PUT/v3/inventory_transfer/:id

Update Inventory Transfer

Update one Inventory Transfer by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to update

Body parameters

Consumes

The following content type is required: application/json

  • Name
    fromLocationId
    Type
    string
    Description
  • Name
    toLocationId
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied
    Description
  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inventory_transfer/:id
curl https://api.shopmonkey.cloud/v3/inventory_transfer/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PUT -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true
}
PATCH/v3/inventory_transfer/:id/:action

Soft Delete Inventory Transfer

Soft delete or undelete a Inventory Transfer by id

URL parameters

  • Name
    action
    Type
    one of: 'delete', 'undelete' Required
    Description
    the action to take
  • Name
    id
    Type
    string Required
    Description
    primary key for the record

Body parameters

Consumes

The following content type is required: application/json

  • Name
    reason
    Type
    string Required
    Description
    the reason message if deleted

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryTransfer schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied Required
    Description
  • Name
    totalCount
    Type
    integer Required
    Description
    the total count of all the items in the transfer
  • Name
    totalRetailCostCents
    Type
    integer Required
    Description
    the total cost of all the items in the transfer
  • Name
    totalWholesaleCostCents
    Type
    integer Required
    Description
    the total wholesale cost of all the items in the transfer
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PATCH
/v3/inventory_transfer/:id/:action
curl https://api.shopmonkey.cloud/v3/inventory_transfer/ID/ACTION \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PATCH -H 'Content-Type: application/json' \ 
  --data '{ "reason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "companyId": "companyId",
    "createdDate": "createdDate",
    "updatedDate": null,
    "number": 1,
    "fromLocationId": null,
    "toLocationId": null,
    "orderId": null,
    "note": "note",
    "status": "status",
    "totalCount": 1,
    "totalRetailCostCents": 1,
    "totalWholesaleCostCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  }
}
DELETE/v3/inventory_transfer/:id

Delete Inventory Transfer

Permanently delete a Inventory Transfer by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id of the record to delete

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    undefined
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inventory_transfer/:id
curl https://api.shopmonkey.cloud/v3/inventory_transfer/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X DELETE -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true
}