Purchase Order Part

WIP: A summary needs to be written for Purchase Order Part

GET/v3/purchase_order_part/:id

Find purchase order part

Find the purchase order part by id

URL parameters

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

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

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    costCents
    Type
    integer Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inventoryPartId
    Type
    string Required
    Description
  • Name
    linkedToServiceItem
    Type
    boolean Required
    Description
    flag to indicate if the item was linked to any service item during swap
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    name
    Type
    string Required
    Description
  • Name
    number
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    providerData
    Type
    object
    Description
  • Name
    purchaseOrderId
    Type
    string Required
    Description
  • Name
    quantity
    Type
    number Required
    Description
  • Name
    receivedQuantity
    Type
    number Required
    Description
  • Name
    returnedQuantity
    Type
    number Required
    Description
    quantity returned to vendor
  • Name
    status
    Type
    one of: Cancelled, Draft, Fulfilled, Ordered, Received Required
    Description
  • Name
    taxable
    Type
    boolean Required
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    purchaseOrder
    Type
    object Required
    Description
    PurchaseOrder schema

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

Properties for purchaseOrder object

  • Name
    calculatedItemsCount
    Type
    integer Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    customGst
    Type
    boolean Required
    Description
    skip US GST calc by system, should be "true" if GST total is modified by user
  • Name
    customHst
    Type
    boolean Required
    Description
    skip CA HST calc by system, should be "true" if HST total is modified by user
  • Name
    customPst
    Type
    boolean Required
    Description
    skip US PST calc by system, should be "true" if PST total is modified by user
  • Name
    customTax
    Type
    boolean Required
    Description
    skip US tax calc by system, should be "true" if tax total is modified by user
  • Name
    externalNumber
    Type
    string Required
    Description
    allow user to override generated number
  • Name
    fulfilledDate
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
    calculated by system if "customGst" = "false"
  • Name
    hstCents
    Type
    integer Required
    Description
    calculated by system if "customHst" = "false"
  • Name
    id
    Type
    string Required
    Description
  • Name
    invoiceNumber
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    note
    Type
    string Required
    Description
  • Name
    number
    Type
    string Required
    Description
    COLLATE "en-u-kn-true"
  • Name
    orderedDate
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    provider
    Type
    one of: PartsTech, Nexpart, Epicor, Worldpac, ATD, RepairLink Required
    Description
  • Name
    providerData
    Type
    object
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
    calculated by system if "customPst" = "false"
  • Name
    session
    Type
    object
    Description
  • Name
    status
    Type
    one of: Draft, Ordered, Received, Fulfilled, Cancelled Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
    calculated by system if "customTax" = "false"
  • Name
    taxConfigId
    Type
    string Required
    Description
  • Name
    totalCostCents
    Type
    integer Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    vendorId
    Type
    string 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/purchase_order_part/:id
curl https://api.shopmonkey.cloud/v3/purchase_order_part/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "companyId": "companyId",
    "locationId": "locationId",
    "purchaseOrderId": "purchaseOrderId",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "name": "name",
    "number": "number",
    "costCents": 1,
    "quantity": 1,
    "receivedQuantity": 1,
    "ordinal": 1,
    "inventoryPartId": null,
    "purchaseOrder": {
      "id": "id",
      "companyId": "companyId",
      "locationId": "locationId",
      "meta": {
        "userId": "userId",
        "sessionId": "sessionId",
        "version": 1
      },
      "number": 1,
      "status": "status",
      "totalCostCents": 1,
      "invoiceNumber": null,
      "orderId": null,
      "note": null,
      "provider": null,
      "createdDate": "createdDate",
      "updatedDate": null,
      "orderedDate": null,
      "fulfilledDate": null,
      "vendorId": null
    }
  }
}
DELETE/v3/purchase_order_part/:id

Delete a purchase order part

Permanently delete a purchase order part by id`

URL parameters

  • Name
    id
    Type
    string Required
    Description
    The unique purchase order part identifier

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

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

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

Example Response
application/json

{
  "success": true
}