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
    lastRefreshedAt
    Type
    string
    Description
    the last refreshed at timestamp
  • 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
    object
    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
    object
    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
  • Name
    receivedQuantity
    Type
    number
    Description
    the quantity received (defaults to 0 for new items)

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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inventoryPartId
    Type
    string Required
    Description
  • Name
    inventoryTireId
    Type
    string Required
    Description
  • 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
    quantity
    Type
    number Required
    Description
  • Name
    receivedQuantity
    Type
    number Required
    Description
    Tracks how much has been received for partial receiving support
  • 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
    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
    transferId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • 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

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    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
    object
    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
  }
}
POST/v3/inventory_transfer/:transferId/bulk

Create Multiple Transfer Items

Creates multiple items for an inventory transfer in a single request

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

Array of objects with the following properties:

Produces

The response content type: application/json

200 Response

  • Name
    count
    Type
    number Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

Example Request
application/json

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

Example Response
application/json

{
  "count": 1,
  "success": true
}
POST/v3/inventory_transfer/:transferId/items

Create Multiple Transfer Items

Creates multiple items for an inventory transfer in a single request

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

Array of objects with the following properties:

Produces

The response content type: application/json

200 Response

  • Name
    count
    Type
    number Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

Example Request
application/json

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

Example Response
application/json

{
  "count": 1,
  "success": true
}
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
  • Name
    receivedQuantity
    Type
    number
    Description
    the quantity received (for partial receiving support)

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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inventoryPartId
    Type
    string Required
    Description
  • Name
    inventoryTireId
    Type
    string Required
    Description
  • 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
    quantity
    Type
    number Required
    Description
  • Name
    receivedQuantity
    Type
    number Required
    Description
    Tracks how much has been received for partial receiving support
  • 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
    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
    transferId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • 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

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    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
    object
    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
  }
}
PUT/v3/inventory_transfer/:transferId/bulk

Update Multiple Transfer Items

Updates multiple items for an inventory transfer in a single request

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

Array of objects with the following properties:

Produces

The response content type: application/json

200 Response

  • Name
    count
    Type
    number Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

Example Request
application/json

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

Example Response
application/json

{
  "count": 1,
  "success": true
}
PUT/v3/inventory_transfer/:transferId/items

Update Multiple Transfer Items

Updates multiple items for an inventory transfer in a single request

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

Array of objects with the following properties:

Produces

The response content type: application/json

200 Response

  • Name
    count
    Type
    number Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

Example Request
application/json

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

Example Response
application/json

{
  "count": 1,
  "success": true
}
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
    object
    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 Inventory Transfer

Find one Inventory Transfer 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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been 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
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    totalCount
    Type
    number 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
    updatedDate
    Type
    string Required
    Description
  • Name
    wasRequested
    Type
    boolean Required
    Description
    tracks if the transfer was ever moved beyond Draft status
  • 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
    object
    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
    object
    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 Inventory Transfer entities

Search for Inventory Transfer Entries

Body parameters

Consumes

The following content type is required: application/json

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • 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
    object
    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
    object
    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
    object
    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 Inventory Transfer

Create one Inventory Transfer

Body parameters

Consumes

The following content type is required: application/json

  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled
    Description
  • Name
    toLocationId
    Type
    string
    Description
  • Name
    wasRequested
    Type
    boolean
    Description
    tracks if the transfer was ever moved beyond Draft status
  • 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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been 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
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    totalCount
    Type
    number 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
    updatedDate
    Type
    string Required
    Description
  • Name
    wasRequested
    Type
    boolean Required
    Description
    tracks if the transfer was ever moved beyond Draft status

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    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
    object
    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
  }
}
POST/v3/inventory_transfer/composite

Create Composite Transfer

Creates an inventory transfer with items in a single request

Body parameters

Consumes

The following content type is required: application/json

  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    one of: any, any
    Description
    fromLocationId is required when creating a transfer with items
  • Name
    note
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled
    Description
  • Name
    toLocationId
    Type
    string
    Description
  • Name
    wasRequested
    Type
    boolean
    Description
    tracks if the transfer was ever moved beyond Draft status
  • Name
    companyId
    Type
    string
    Description
  • Name
    items
    Type
    array Required
    Description
    items to add to the transfer

Produces

The response content type: application/json

200 Response

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

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been 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
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    totalCount
    Type
    number 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
    updatedDate
    Type
    string Required
    Description
  • Name
    wasRequested
    Type
    boolean Required
    Description
    tracks if the transfer was ever moved beyond Draft status
  • Name
    items
    Type
    array Required
    Description

Example Request
application/json

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

Example Response
application/json

{
  "data": {
    "companyId": "companyId",
    "createdDate": "createdDate",
    "deleted": true,
    "deletedDate": null,
    "deletedReason": null,
    "deletedUserId": null,
    "fromLocationId": null,
    "id": "id",
    "note": "note",
    "number": 1,
    "orderId": null,
    "status": "status",
    "toLocationId": null,
    "totalCount": 1,
    "totalRetailCostCents": 1,
    "totalWholesaleCostCents": 1,
    "updatedDate": null,
    "wasRequested": true,
    "items": [
      {
        "id": "id",
        "quantity": 1,
        "receivedQuantity": 1,
        "retailCostCents": null,
        "wholesaleCostCents": null,
        "inventoryPart": {
          "availableQuantity": 1,
          "id": "id",
          "name": "name",
          "normalizedSKU": null,
          "retailCostCents": 1,
          "sku": null,
          "wholesaleCostCents": null
        },
        "inventoryTire": {
          "availableQuantity": 1,
          "id": "id",
          "name": "name",
          "normalizedSKU": null,
          "retailCostCents": 1,
          "size": null,
          "sku": null,
          "wholesaleCostCents": null,
          "tireModel": {
            "name": "name",
            "brand": {
              "name": "name"
            }
          }
        }
      }
    ]
  },
  "success": true
}
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
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled
    Description
  • Name
    toLocationId
    Type
    string
    Description
  • Name
    wasRequested
    Type
    boolean
    Description
    tracks if the transfer was ever moved beyond Draft status
  • Name
    expectedUpdatedDate
    Type
    string
    Description
    Optimistic concurrency token. Pass the updatedDate the client last loaded for this transfer. If the current updatedDate is newer, the request is rejected with 409 so the client can refresh.
  • Name
    itemsChanged
    Type
    boolean
    Description
    Set to true if items were modified before this update. Affects notification timing - notifications will be sent after totals are recalculated.

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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been 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
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    totalCount
    Type
    number 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
    updatedDate
    Type
    string Required
    Description
  • Name
    wasRequested
    Type
    boolean Required
    Description
    tracks if the transfer was ever moved beyond Draft status

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    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
    object
    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
    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
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been 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
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    fromLocationId
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    integer Required
    Description
    the number of the transfer
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    status
    Type
    one of: Draft, Requested, Approved, Denied, InTransit, Received, Fulfilled, Canceled Required
    Description
  • Name
    toLocationId
    Type
    string Required
    Description
  • Name
    totalCount
    Type
    number 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
    updatedDate
    Type
    string Required
    Description
  • Name
    wasRequested
    Type
    boolean Required
    Description
    tracks if the transfer was ever moved beyond Draft status

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    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
    object
    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 '{}'

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
  }
}