Workflow

WIP: A summary needs to be written for Workflow

PUT/v3/order/workflow_status/bulk

Bulk update archived status in Workflow

Bulk update the archived status of workflow orders

Body parameters

Consumes

The following content type is required: application/json

  • Name
    archived
    Type
    boolean Required
    Description
    Indicates whether the order should be archived
  • Name
    workflowStatusId
    Type
    string Required
    Description
    The identifier for the workflow status

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

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/order/workflow_status/bulk
curl https://api.shopmonkey.cloud/v3/order/workflow_status/bulk \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{ "archived" : false, "workflowStatusId" : "value" }'

Example Response
application/json

{
  "success": true
}
GET/v3/workflow

Find Workflows

Find all Workflows

Query String parameters

  • Name
    limit
    Type
    number
    Description
  • Name
    orderby
    Type
    string
    Description
  • Name
    where
    Type
    string
    Description
  • Name
    filterInactiveOrders
    Type
    boolean
    Description

Produces

The response content type: application/json

200 Response

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

Properties for meta object

  • Name
    inactive
    Type
    number
    Description
  • Name
    inactiveByStatus
    Type
    object
    Description
  • Name
    total
    Type
    number 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

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/workflow
curl https://api.shopmonkey.cloud/v3/workflow \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {},
  "meta": {
    "inactive": 1,
    "inactiveByStatus": {},
    "total": 1
  },
  "success": true
}
GET/v3/workflow/:id

Find Column

Find a specific column for the Workflow

URL parameters

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

Query String parameters

  • Name
    limit
    Type
    number
    Description
  • Name
    orderby
    Type
    string
    Description
  • Name
    where
    Type
    string
    Description
  • Name
    filterInactiveOrders
    Type
    boolean
    Description
  • Name
    skip
    Type
    number
    Description

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
    hasMore
    Type
    boolean Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    nextOrdinal
    Type
    number
    Description
  • Name
    orders
    Type
    array Required
    Description
  • Name
    position
    Type
    number Required
    Description
  • Name
    total
    Type
    number 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

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/workflow/:id
curl https://api.shopmonkey.cloud/v3/workflow/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "hasMore": true,
    "name": "name",
    "nextOrdinal": 1,
    "orders": [
      {
        "appointmentDates": [
          "2024-01-01T00:00:00.000Z"
        ],
        "archived": true,
        "assignedTechnicianIds": [
          "assignedTechnicianIds"
        ],
        "authorized": true,
        "authorizedDate": null,
        "coalescedName": null,
        "completedDate": null,
        "customerId": null,
        "dueDate": null,
        "fullyPaidDate": null,
        "generatedCustomerName": null,
        "generatedVehicleName": null,
        "hasPayments": true,
        "id": "id",
        "inspectionReviewStatus": "inspectionReviewStatus",
        "inspectionStatus": "inspectionStatus",
        "invoiced": true,
        "invoicedDate": null,
        "invoiceLockState": "invoiceLockState",
        "messageCount": 1,
        "messagedDate": null,
        "number": "number",
        "orderCreatedDate": "orderCreatedDate",
        "paid": true,
        "paymentDueDate": null,
        "paymentTermId": null,
        "publicId": "publicId",
        "readOnly": true,
        "serviceWriterId": null,
        "shopUnreadMessageCount": 1,
        "status": "status",
        "vehicleId": null,
        "workflowStatusDate": "workflowStatusDate",
        "workflowStatusId": null,
        "workflowStatusPosition": null,
        "paidCostCents": null,
        "remainingCostCents": null,
        "totalCostCents": null,
        "limitedView": true,
        "customerDeleted": true,
        "paymentTermName": "paymentTermName",
        "vehicleColor": "vehicleColor",
        "vehicleCustomPhoto": true,
        "vehicleDeleted": true,
        "vehicleHin": "vehicleHin",
        "vehicleLicensePlate": "vehicleLicensePlate",
        "vehicleStockPhoto": true,
        "vehicleType": "vehicleType",
        "vehicleUnit": "vehicleUnit",
        "vehicleVin": "vehicleVin",
        "completedAuthorizedLaborHours": 1,
        "completedLaborHours": 1,
        "customerPhoneNumber": "customerPhoneNumber",
        "totalAuthorizedLaborHours": 1,
        "totalLaborHours": 1,
        "updatedDate": "updatedDate"
      }
    ],
    "position": 1,
    "total": 1
  },
  "success": true
}
GET/v3/workflow/list/:statusId

List all orders

Get list of all workflow orders with optional filter by workflowStatusId

URL parameters

  • Name
    statusId
    Type
    string
    Description
    the id for the workflow status

Query String parameters

  • Name
    limit
    Type
    number
    Description
  • Name
    orderby
    Type
    string
    Description
  • Name
    where
    Type
    string
    Description
  • Name
    filterInactiveOrders
    Type
    boolean
    Description
  • Name
    skip
    Type
    number
    Description

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
    hasMore
    Type
    boolean Required
    Description
  • Name
    inactive
    Type
    number
    Description
  • Name
    inactiveByStatus
    Type
    object
    Description
  • Name
    orders
    Type
    array Required
    Description
  • Name
    total
    Type
    number 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

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/workflow/list/:statusId
curl https://api.shopmonkey.cloud/v3/workflow/list/:statusId \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "hasMore": true,
    "inactive": 1,
    "inactiveByStatus": {},
    "orders": [
      {
        "appointmentDates": [
          "2024-01-01T00:00:00.000Z"
        ],
        "archived": true,
        "assignedTechnicianIds": [
          "assignedTechnicianIds"
        ],
        "authorized": true,
        "authorizedDate": null,
        "coalescedName": null,
        "completedDate": null,
        "customerId": null,
        "dueDate": null,
        "fullyPaidDate": null,
        "generatedCustomerName": null,
        "generatedVehicleName": null,
        "hasPayments": true,
        "id": "id",
        "inspectionReviewStatus": "inspectionReviewStatus",
        "inspectionStatus": "inspectionStatus",
        "invoiced": true,
        "invoicedDate": null,
        "invoiceLockState": "invoiceLockState",
        "messageCount": 1,
        "messagedDate": null,
        "number": "number",
        "orderCreatedDate": "orderCreatedDate",
        "paid": true,
        "paymentDueDate": null,
        "paymentTermId": null,
        "publicId": "publicId",
        "readOnly": true,
        "serviceWriterId": null,
        "shopUnreadMessageCount": 1,
        "status": "status",
        "vehicleId": null,
        "workflowStatusDate": "workflowStatusDate",
        "workflowStatusId": null,
        "workflowStatusPosition": null,
        "paidCostCents": null,
        "remainingCostCents": null,
        "totalCostCents": null,
        "limitedView": true,
        "customerDeleted": true,
        "paymentTermName": "paymentTermName",
        "vehicleColor": "vehicleColor",
        "vehicleCustomPhoto": true,
        "vehicleDeleted": true,
        "vehicleHin": "vehicleHin",
        "vehicleLicensePlate": "vehicleLicensePlate",
        "vehicleStockPhoto": true,
        "vehicleType": "vehicleType",
        "vehicleUnit": "vehicleUnit",
        "vehicleVin": "vehicleVin",
        "updatedDate": "updatedDate"
      }
    ],
    "total": 1
  },
  "success": true
}
GET/v3/workflow/part

Find Parts

Find all Workflow Parts

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

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
    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/workflow/part
curl https://api.shopmonkey.cloud/v3/workflow/part \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "binLocation": "binLocation",
      "calculatedCOGSCents": null,
      "categoryId": null,
      "companyId": "companyId",
      "createdDate": "createdDate",
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "fixedPriceLimitPriceCents": null,
      "fixedPriceLimitQuantity": null,
      "fixedPriceLimitType": null,
      "id": "id",
      "inventoryPartId": null,
      "inventoryStatus": "inventoryStatus",
      "inventoryTransferPartId": null,
      "locationId": "locationId",
      "motorApplicationId": null,
      "motorCommercialPartsId": null,
      "name": "name",
      "normalizedSKU": null,
      "note": "note",
      "orderId": "orderId",
      "ordinal": 1,
      "originalWholesaleCostCents": null,
      "partNumber": null,
      "pcDbTerminologyId": null,
      "pricingMatrixDate": null,
      "pricingMatrixId": null,
      "provider": null,
      "providerApplicationId": null,
      "purchaseOrderPartId": null,
      "purchaseStatus": null,
      "quantity": 1,
      "reduceInventoryCount": true,
      "reserved": true,
      "retailCostCents": 1,
      "serviceId": "serviceId",
      "showCostAndQuantity": true,
      "showNote": true,
      "showPartNumber": true,
      "sku": null,
      "sourceItemId": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "updatedDate": null,
      "url": null,
      "vendorId": null,
      "wholesaleCostCents": null,
      "lineItemAssignments": [
        {
          "id": "id",
          "userId": "userId"
        }
      ],
      "order": {
        "archived": true,
        "authorized": true,
        "coalescedName": null,
        "generatedCustomerName": null,
        "generatedName": null,
        "generatedVehicleName": null,
        "id": "id",
        "invoiced": true,
        "invoiceLockState": "invoiceLockState",
        "name": null,
        "number": "number",
        "readOnly": true,
        "status": "status",
        "workflowStatusId": null,
        "purchaseOrders": [
          {
            "id": "id",
            "number": "number",
            "provider": null,
            "status": "status"
          }
        ]
      },
      "partReturns": [
        {
          "amountCents": 1,
          "companyId": "companyId",
          "createdDate": "createdDate",
          "creditInvoiceNumber": null,
          "creditMethod": null,
          "gstCents": 1,
          "gstPercent": 1,
          "hstCents": 1,
          "hstPercent": 1,
          "id": "id",
          "inventoryPartId": null,
          "inventoryTireId": null,
          "locationId": "locationId",
          "note": null,
          "orderId": null,
          "partId": null,
          "partReturnPartType": "partReturnPartType",
          "pstCents": 1,
          "pstPercent": 1,
          "purchaseOrderId": null,
          "purchaseOrderPartId": null,
          "purchaseOrderTireId": null,
          "quantity": 1,
          "reason": null,
          "referenceId": null,
          "refundedDate": null,
          "returnedDate": null,
          "returnType": "returnType",
          "status": "status",
          "taxable": true,
          "taxableGST": true,
          "taxableHST": true,
          "taxablePST": true,
          "taxCents": 1,
          "taxConfigId": null,
          "taxPercent": 1,
          "tireId": null,
          "totalCents": 1,
          "updatedDate": null,
          "vendorInvoiceNumber": null
        }
      ],
      "purchaseOrderPart": {
        "purchaseOrder": {
          "id": "id",
          "number": "number",
          "provider": null,
          "status": "status"
        }
      },
      "service": {
        "id": "id",
        "name": "name"
      },
      "vendor": {
        "id": "id",
        "name": "name"
      }
    }
  ],
  "success": true
}
GET/v3/workflow/tire

Find Tires

Find all Workflow Tires

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

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
    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/workflow/tire
curl https://api.shopmonkey.cloud/v3/workflow/tire \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "binLocation": null,
      "calculatedCOGSCents": null,
      "calculatedName": "calculatedName",
      "companyId": "companyId",
      "createdDate": "createdDate",
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "federalExciseTaxCents": 1,
      "generatedBrandName": "generatedBrandName",
      "generatedModelName": "generatedModelName",
      "id": "id",
      "inventoryStatus": "inventoryStatus",
      "inventoryTireId": null,
      "inventoryTransferTireId": null,
      "locationId": "locationId",
      "name": "name",
      "normalizedSKU": null,
      "note": null,
      "orderId": "orderId",
      "ordinal": 1,
      "originalWholesaleCostCents": null,
      "partNumber": null,
      "pricingMatrixDate": null,
      "pricingMatrixId": null,
      "purchaseOrderTireId": null,
      "purchaseStatus": null,
      "quantity": 1,
      "reduceInventoryCount": true,
      "reserved": true,
      "retailCostCents": 1,
      "serviceId": "serviceId",
      "showNote": true,
      "showPartNumber": true,
      "showPriceAndQuantity": true,
      "size": null,
      "sizeFormat": "sizeFormat",
      "sku": null,
      "sourceItemId": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "tireIdentificationNumbers": [
        "tireIdentificationNumbers"
      ],
      "tireModelId": null,
      "updatedDate": null,
      "url": null,
      "wasteTireFee": 1,
      "wholesaleCostCents": null,
      "lineItemAssignments": [
        {
          "id": "id",
          "userId": "userId"
        }
      ],
      "order": {
        "archived": true,
        "authorized": true,
        "coalescedName": null,
        "generatedCustomerName": null,
        "generatedName": null,
        "generatedVehicleName": null,
        "id": "id",
        "invoiced": true,
        "invoiceLockState": "invoiceLockState",
        "name": null,
        "number": "number",
        "readOnly": true,
        "status": "status",
        "workflowStatusId": null,
        "purchaseOrders": [
          {
            "id": "id",
            "number": "number",
            "provider": null,
            "status": "status"
          }
        ]
      },
      "purchaseOrderTire": {
        "purchaseOrder": {
          "id": "id",
          "number": "number",
          "provider": null,
          "status": "status"
        }
      },
      "service": {
        "id": "id",
        "name": "name"
      },
      "tireModel": {
        "id": "id",
        "name": "name",
        "brand": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    }
  ],
  "success": true
}
GET/v3/workflow/core_charge

Find Core Charges

Find all Workflow Core Charges

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

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/workflow/core_charge
curl https://api.shopmonkey.cloud/v3/workflow/core_charge \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "amountCents": 1,
      "companyId": "companyId",
      "createdDate": "createdDate",
      "id": "id",
      "locationId": "locationId",
      "partId": "partId",
      "referenceId": null,
      "status": "status",
      "updatedDate": null,
      "order": {
        "id": "id",
        "number": "number"
      },
      "part": {
        "id": "id",
        "name": "name",
        "partNumber": null
      },
      "vendor": {
        "id": "id",
        "name": "name"
      }
    }
  ],
  "success": true
}