Hq

WIP: A summary needs to be written for Hq

POST/v3/location

Create New Location

Create a new location for a company

Body parameters

  • Name
    name
    Type
    string Required
    Description
  • Name
    address1
    Type
    string Required
    Description
  • Name
    address2
    Type
    string
    Description
  • Name
    city
    Type
    string Required
    Description
  • Name
    state
    Type
    string Required
    Description
  • Name
    postalCode
    Type
    string Required
    Description
  • Name
    country
    Type
    string Required
    Description
  • Name
    privacyPolicy
    Type
    string
    Description
  • Name
    termsAndConditions
    Type
    string
    Description
  • Name
    website
    Type
    string
    Description
  • Name
    timezone
    Type
    string
    Description
  • Name
    email
    Type
    string
    Description
  • Name
    contactName
    Type
    string
    Description
  • Name
    phone
    Type
    string
    Description
  • Name
    showNameOnDocuments
    Type
    boolean
    Description
  • Name
    showWebsiteOnDocuments
    Type
    boolean
    Description
  • Name
    showEmailOnDocuments
    Type
    boolean
    Description
  • Name
    certifications
    Type
    object
    Description
  • Name
    latitude
    Type
    number
    Description
  • Name
    longitude
    Type
    number
    Description
  • Name
    archived
    Type
    boolean
    Description
  • Name
    geolocationId
    Type
    string
    Description
  • Name
    showCompanyLogo
    Type
    boolean
    Description
    whether or not to use the company logo
  • Name
    locationSubscriptionId
    Type
    string
    Description
  • Name
    externalId
    Type
    string
    Description
    a location identifier that can be used by multi-location companies
  • Name
    companyId
    Type
    string Required
    Description

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
    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
    Location schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    address1
    Type
    string Required
    Description
  • Name
    address2
    Type
    string Required
    Description
  • Name
    city
    Type
    string Required
    Description
  • Name
    state
    Type
    string Required
    Description
  • Name
    postalCode
    Type
    string Required
    Description
  • Name
    country
    Type
    string Required
    Description
  • Name
    privacyPolicy
    Type
    string Required
    Description
  • Name
    termsAndConditions
    Type
    string Required
    Description
  • Name
    website
    Type
    string Required
    Description
  • Name
    timezone
    Type
    string Required
    Description
  • Name
    email
    Type
    string Required
    Description
  • Name
    contactName
    Type
    string Required
    Description
  • Name
    phone
    Type
    string Required
    Description
  • Name
    showNameOnDocuments
    Type
    boolean Required
    Description
  • Name
    showWebsiteOnDocuments
    Type
    boolean Required
    Description
  • Name
    showEmailOnDocuments
    Type
    boolean Required
    Description
  • Name
    certifications
    Type
    object
    Description
  • Name
    latitude
    Type
    number Required
    Description
  • Name
    longitude
    Type
    number Required
    Description
  • Name
    archived
    Type
    boolean Required
    Description
  • Name
    showCompanyLogo
    Type
    boolean Required
    Description
    whether or not to use the company logo
  • Name
    locationSubscriptionId
    Type
    string Required
    Description
  • Name
    externalId
    Type
    string Required
    Description
    a location identifier that can be used by multi-location companies

4xx 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 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
    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/location
curl https://api.shopmonkey.cloud/v3/location \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X POST -H 'Content-Type: application/json' \ 
  --data '{ "name" : "value", "address1" : "value", "city" : "value", "state" : "value", "postalCode" : "value", "country" : "value", "companyId" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": "name",
    "address1": "address1",
    "address2": null,
    "city": "city",
    "state": "state",
    "postalCode": "postalCode",
    "country": "country",
    "privacyPolicy": null,
    "termsAndConditions": null,
    "website": null,
    "timezone": "timezone",
    "email": null,
    "contactName": null,
    "phone": null,
    "showNameOnDocuments": true,
    "showWebsiteOnDocuments": true,
    "showEmailOnDocuments": true,
    "latitude": 1,
    "longitude": 1,
    "archived": true,
    "showCompanyLogo": true,
    "locationSubscriptionId": null
  }
}
GET/v3/user

List Users

Find all users

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

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

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "active": true,
      "deactivatedByUserId": null,
      "deactivatedDate": null,
      "laborRateId": null,
      "firstName": "firstName",
      "lastName": "lastName",
      "email": "email",
      "phone": null,
      "color": "color",
      "currentLocationId": null,
      "customFields": {},
      "laborRate": {
        "valueCents": 1
      },
      "userRoles": [
        {
          "role": {
            "id": "id",
            "name": "name",
            "derivedFrom": {
              "name": "name"
            }
          }
        }
      ],
      "deactivator": {
        "id": "id",
        "companyId": "companyId",
        "active": true,
        "firstName": "firstName",
        "lastName": "lastName",
        "color": "color"
      },
      "company": {
        "createdDate": "createdDate",
        "name": "name"
      },
      "location": {
        "country": "country",
        "createdDate": "createdDate",
        "name": "name",
        "state": "state",
        "timezone": "timezone",
        "locationConfig": {
          "requireMileageRecordBeforeInvoice": true
        }
      }
    }
  ]
}