lib/swagger/blaze-taxnexus.yaml

8799 lines
284 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

swagger: "2.0"
info:
version: 1.2.7
contact:
email: "noc@taxnexus.net"
license:
name: "Proprietary"
termsOfService: "https://www.taxnexus.com/terms/"
title: "vendor-gw-blaze"
description:
"Taxnexus Gateway Client API for Blaze.me Cannabis Management System"
host: "api.blaze.me"
basePath: "/api/v1"
schemes:
- "https"
securityDefinitions:
ApiKeyAuth:
type: "apiKey"
in: "header"
name: "X-API-Key"
security:
- ApiKeyAuth: []
consumes:
- "application/json"
produces:
- "application/json"
parameters:
activeStatusQuery:
description: "Get Active objects?"
in: "query"
name: "Active"
type: boolean
required: false
startDateQueryRequired:
description: "The start date of transaction query"
in: "query"
type: string
name: "startDate"
required: true
endDateQueryRequired:
description: "The end date of transaction query"
in: "query"
type: string
name: "endDate"
required: true
productionQuery:
description: "Use Production API?"
in: "query"
type: boolean
name: "production"
required: false
stateCodeQuery:
description: "The 2-character State Code"
in: "query"
type: string
name: "state"
required: true
paginationStartQuery:
description: "The starting record in multi-record retrievals"
type: number
in: "query"
name: "start"
required: false
paginationLimitQuery:
description: "The number of records to retrieve"
type: number
in: "query"
name: "limit"
required: false
itemNumberPathRequired:
description: "The Blaze Transaction Number"
in: "path"
type: string
name: "itemNumber"
required: true
productIdPathRequired:
description: "The Blaze Product Object Id"
in: "path"
type: string
name: "productId"
required: true
vendorIdPathRequired:
description: "The Blaze Vendor Object Id"
in: "path"
type: string
name: "vendorId"
required: true
memberIdPathRequired:
description: "The Blaze Member Object Id"
in: "path"
type: string
name: "memberId"
required: true
responses:
Unauthorized:
description: "Access unauthorized, invalid API-KEY was used"
schema:
$ref: "#/definitions/Error"
AccessForbidden:
description: "Access forbidden, account lacks access"
schema:
$ref: "#/definitions/Error"
Conflict:
description: "Conflict"
schema:
$ref: "#/definitions/Error"
InvalidDataError:
description: "Invalid data was sent"
schema:
$ref: "#/definitions/InvalidError"
ServerError:
description: "Server Internal Error"
schema:
$ref: "#/definitions/Error"
NotFound:
description: "Resource was not found"
schema:
$ref: "#/definitions/Error"
ServerMessage:
description: "A server message"
schema:
$ref: "#/definitions/Message"
paths:
"/partner/members/{memberId}":
get:
tags:
- Members
operationId: "getMember"
description: "Get A Member (contact)"
parameters:
- $ref: "#/parameters/memberIdPathRequired"
responses:
"200":
description: "Product was successfully retrieved"
schema:
$ref: "#/definitions/MemberResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/products":
get:
tags:
- Products
operationId: "getProducts"
description: "Get All Products"
responses:
"200":
description: "Products were successfully retrieved"
schema:
$ref: "#/definitions/ProductsResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/products/{productId}":
get:
tags:
- Products
operationId: "getProduct"
description: "Get A Product"
parameters:
- $ref: "#/parameters/productIdPathRequired"
responses:
"200":
description: "Product was successfully retrieved"
schema:
$ref: "#/definitions/ProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/store":
get:
tags:
- Shop
operationId: "getShop"
description: "Get basic Shop parameters"
responses:
"200":
description: "Shop was successfully retrieved"
schema:
$ref: "#/definitions/ShopResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/store/purchaseOrder/list":
get:
tags:
- Purchase Orders
operationId: "getPurchaseOrderList"
description: "Get a list of purchase orders"
parameters:
- $ref: "#/parameters/startDateQueryRequired"
- $ref: "#/parameters/endDateQueryRequired"
- $ref: "#/parameters/paginationLimitQuery"
- $ref: "#/parameters/paginationStartQuery"
responses:
"200":
description: "Shop was successfully retrieved"
schema:
$ref: "#/definitions/PurchaseOrderListResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/transactions":
get:
tags:
- Transactions
operationId: "getTransactions"
description: "Get a Range of Transactions"
parameters:
- $ref: "#/parameters/startDateQueryRequired"
- $ref: "#/parameters/endDateQueryRequired"
- $ref: "#/parameters/paginationLimitQuery"
- $ref: "#/parameters/paginationStartQuery"
responses:
"200":
description: "Transactions were successfully retrieved"
schema:
$ref: "#/definitions/TransactionsResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/transactions/{itemNumber}":
get:
tags:
- Transactions
operationId: "getTransactionById"
description: "Get a single transaction by ID"
parameters:
- $ref: "#/parameters/itemNumberPathRequired"
responses:
"200":
description: "A Transaction was successfully retrieved"
schema:
$ref: "#/definitions/TransactionByIdResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
"/partner/vendors/{vendorId}":
get:
tags:
- Vendors
operationId: "getVendor"
description: "Get A Vendor"
parameters:
- $ref: "#/parameters/vendorIdPathRequired"
responses:
"200":
description: "Product was successfully retrieved"
schema:
$ref: "#/definitions/VendorResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
definitions:
Error:
properties:
error:
type: string
status:
maximum: 600
minimum: 100
type: integer
type: object
InvalidError:
allOf:
- $ref: "#/definitions/Error"
- properties:
details:
items:
type: string
type: array
type: object
MemberResponse:
properties:
activeTransaction:
example: 0
type: number
address:
properties:
address:
example: 5125 Miles Ave
type: string
city:
example: Oakland
type: string
companyId:
example: string
type: string
country:
example: US
type: string
created:
example: 1554826014782
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cacc31e6218d174d3f17b6d
type: string
modified:
example: 1554826014782
format: int64
type: number
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "94618"
type: string
type: object
addresses:
example:
- string
items:
type: string
type: array
agreementExpired:
example: false
type: boolean
anonymous:
example: false
type: boolean
banPatient:
example: false
type: boolean
cannabisResult:
example: string
type: string
careGiverList:
example:
- string
items:
type: string
type: array
careGivers:
example:
- string
items:
type: string
type: array
companyId:
example: 5cabd4ba6218d148395b402c
type: string
consumerType:
example: AdultUse
type: string
consumerUserId:
example: string
type: string
contracts:
example:
- string
items:
type: string
type: array
created:
example: 1554826014780
format: int64
type: number
currentCannabisLimit:
example: string
type: string
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
dlExpired:
example: false
type: boolean
dob:
example: 631180800000
type: number
email:
example: hokus@taxnexus.net
type: string
emailOptIn:
example: true
type: boolean
emailVerified:
example: false
type: boolean
enableLoyalty:
example: true
type: boolean
enabledCareGiver:
example: false
type: boolean
expStatuses:
example:
- string
items:
type: string
type: array
firstName:
example: Hokus
type: string
id:
example: 5cacc31e6218d174d3f17b70
type: string
identifications:
items:
properties:
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
format: int64
type: number
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554826014782
format: int64
type: number
deleted:
example: false
type: boolean
expirationDate:
example: 1577779200000
format: int64
type: number
frontPhoto:
example: string
type: string
id:
example: 5cacc31e6218d174d3f17b6e
type: string
licenseNumber:
example: MYLICENSENUM
type: string
modified:
example: 1554826014782
format: int64
type: number
state:
example: string
type: string
type:
example: string
type: string
updated:
example: false
type: boolean
type: object
type: array
importId:
example: string
type: string
inQueue:
example: false
type: boolean
lastName:
example: Pokus
type: string
lastVisitDate:
example: 1554826633661
format: int64
type: number
lifetimePoints:
example: 0
type: number
loyaltyPoints:
example: 0
type: number
marketingSource:
example: ""
type: string
medical:
example: false
type: boolean
memberActivities:
example:
- string
items:
type: string
type: array
memberGroup:
properties:
active:
example: true
type: boolean
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554746451740
format: int64
type: number
defaultGroup:
example: true
type: boolean
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
discount:
example: 0
type: number
discountType:
example: Percentage
type: string
enablePromotion:
example: false
type: boolean
id:
example: 5cabd4ba6218d148395b404b
type: string
memberCount:
example: 0
type: number
memberCountEmailOptIn:
example: 0
type: number
memberCountTextOptIn:
example: 0
type: number
modified:
example: 1554824536062
format: int64
type: number
name:
example: Delivery
type: string
promotionId:
example: string
type: string
shopId:
example: 5cabd4ba6218d148395b4043
type: string
updated:
example: false
type: boolean
type: object
memberGroupId:
example: 5cabd4ba6218d148395b404b
type: string
middleName:
example: string
type: string
modified:
example: 1554826633661
format: int64
type: number
notes:
example:
- string
items:
type: string
type: array
preferences:
example:
- string
items:
type: string
type: array
primaryPhone:
example: (510) 859-7000
type: string
qbCustomerRef:
example:
- string
items:
type: string
type: array
qbDesktopCustomerRef:
example: string
type: string
recentProducts:
example:
- Binsky Flower
- Tommy's Bong
items:
type: string
type: array
recommendationExpired:
example: true
type: boolean
recommendationExpiryLeft:
example: 0
type: number
recommendations:
items:
properties:
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
type: number
format: int64
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554826014782
format: int64
type: number
deleted:
example: false
type: boolean
doctor:
example: string
type: string
doctorId:
example: string
type: string
expirationDate:
example: string
type: string
frontPhoto:
example: string
type: string
id:
example: 5cacc31e6218d174d3f17b6f
type: string
issueDate:
example: string
type: string
modified:
example: 1554826014782
format: int64
type: number
recommendationNumber:
example: string
type: string
state:
example: string
type: string
updated:
example: false
type: boolean
verified:
example: false
type: boolean
verifyMethod:
example: MANUAL
type: string
verifyPhoneNumber:
example: string
type: string
verifyWebsite:
example: string
type: string
type: object
type: array
regionId:
example: string
type: string
searchText:
example:
hokus pokus 5125 miles ave hokus@taxnexus.net (510) 859-7000
delivery
type: string
sex:
example: 0
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
startDate:
example: 1554826014781
format: int64
type: number
stateCannabisLimit:
example: string
type: string
status:
example: Active
type: string
tags:
example:
- string
items:
type: string
type: array
textOptIn:
example: true
type: boolean
updated:
example: false
type: boolean
type: object
Message:
properties:
code:
example: 200
type: number
message:
example: successful operation
type: string
type: object
ProductResponse:
properties:
active:
example: true
type: boolean
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1555828648113
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbc0fa83f8de507ff768bfd
type: string
key:
example: 99556cc6-6820-425c-8620-f4ba5a8d601f.jpg
type: string
largeURL:
example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-800x800.jpg"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-1600x1600.jpg"
type: string
mediumURL:
example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-500x500.jpg"
type: string
modified:
example: 1555828648113
type: number
format: int64
name:
example: Lowell 3 5g.jpg
type: string
origURL:
example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f.jpg"
type: string
priority:
example: 0
type: number
publicURL:
example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f.jpg"
type: string
secured:
example: false
type: boolean
thumbURL:
example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-200x200.jpg"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
automaticReOrder:
example: false
type: boolean
brand:
example: string
type: string
brandId:
example: 5cba942502aeca080e3b11e3
type: string
brandName:
example: Lowell Herb Co
type: string
bundleItemResults:
items:
type: string
type: array
bundleItems:
items:
properties:
productId:
type: string
quantity:
format: double
type: number
type: object
type: array
byGram:
example: true
type: boolean
byPrepackage:
example: false
type: boolean
cannabisType:
example: DEFAULT
type: string
category:
properties:
active:
example: true
type: boolean
cannabis:
example: true
type: boolean
cannabisType:
example: DEFAULT
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1553982501834
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5c9fe425e0faca07db94b986
type: string
lowThreshold:
example: 0
type: number
modified:
example: 1553982501834
format: int64
type: number
name:
example: Preroll
type: string
photo:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1553982501834
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5c9fe425e0faca07db94b97a
type: string
key:
example: 420default-Preroll.jpg
type: string
largeURL:
example: string
type: string
largeX2URL:
example: string
type: string
mediumURL:
example: string
type: string
modified:
example: 1553982501834
format: int64
type: number
name:
example: Preroll.jpg
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: "https://s3.amazonaws.com/connect-files-public/420default-Preroll.jpg"
type: string
secured:
example: false
type: boolean
thumbURL:
example: string
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
priority:
example: 0
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
unitType:
example: units
type: string
updated:
example: false
type: boolean
type: object
categoryId:
example: 5c9fe425e0faca07db94b986
type: string
cbd:
example: 0
type: number
cbda:
example: 0
type: number
cbn:
example: 0
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
companyLinkId:
example: MTkwNjFTMDE=
type: string
created:
example: 1555533419406
type: number
format: int64
customGramType:
example: GRAM
type: string
customTaxInfo:
example: string
type: string
customWeight:
example: 0
type: number
deleted:
example: false
type: boolean
description:
example:
"In this pack: A curated, effect based blend of sativa
strains, pre-rolled into seven premium all flower smokes (3.5
grams per pack). All of our products are lab tested, we grow
our flowers with only organic fertilizer, and we never use
synthetic pesticides. Matches included for your convenience."
type: string
dirty:
example: false
type: boolean
discountable:
example: true
type: boolean
enableExciseTax:
example: false
type: boolean
enableMixMatch:
example: false
type: boolean
enableWeedmap:
example: false
type: boolean
flowerType:
example: Sativa
type: string
genetics:
example: string
type: string
id:
example: 5cb78e6b829a5f0834444825
type: string
importId:
example: string
type: string
importSrc:
example: string
type: string
lowInventoryNotification:
example: false
type: boolean
lowThreshold:
example: 0
type: number
medicalConditions:
items:
type: string
type: array
medicinal:
example: true
type: boolean
modified:
example: 1556695451723
format: int64
type: number
name:
example: Lowell - 3.5g Preroll Pack - Uplifting (S)
type: string
notes:
items:
type: string
type: array
potency:
example: false
type: boolean
potencyAmount:
properties:
cbd:
example: 0
type: number
cbda:
example: 0
type: number
cbn:
example: 0
type: number
thc:
example: 0
type: number
thca:
example: 0
type: number
type: object
priceBreaks:
items:
properties:
active:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1555533419417
type: number
format: int64
deleted:
example: false
type: boolean
displayName:
example: string
type: string
id:
example: 5cb78e6b829a5f0834444827
type: string
modified:
example: 1555533419417
format: int64
type: number
name:
example: 1 each
type: string
price:
example: 40
type: number
priceBreakType:
example: OneGramUnit
type: string
priority:
example: 0
type: number
quantity:
example: 1
type: number
updated:
example: false
type: boolean
type: object
type: array
priceIncludesALExcise:
example: false
type: boolean
priceIncludesExcise:
example: false
type: boolean
priceRanges:
items:
type: string
type: array
pricingTemplateId:
example: ""
type: string
productSaleType:
example: Both
type: string
productType:
example: REGULAR
type: string
qbDesktopItemRef:
example: string
type: string
qbItemRef:
example: string
type: string
quantities:
items:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1555633414363
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb91506819d9e04973cc7c2
type: string
inventoryId:
example: 5c9fe425e0faca07db94b992
type: string
modified:
example: 1555633414363
format: int64
type: number
quantity:
example: 0
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
updated:
example: false
type: boolean
type: object
type: array
quantityAvailable:
example: 0
type: number
reOrderLevel:
example: 0
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
showInWidget:
example: true
type: boolean
sku:
example: 19061S01
type: string
tags:
items:
type: string
type: array
taxOrder:
example: PostTaxed
type: string
taxTables:
items:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1555609033636
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb8b5c99c57ec083d307a94
type: string
modified:
example: 1555609033636
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: AdultUse
type: string
countyTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1555609033636
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb8b5c99c57ec083d307a95
type: string
modified:
example: 1555609033636
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1555609033636
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1555609033636
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb8b5c99c57ec083d307a97
type: string
modified:
example: 1555609033636
type: number
format: int64
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5cb8b5c99c57ec083d307a93
type: string
modified:
example: 1555609033636
format: int64
type: number
name:
example: Adult Use
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
stateTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1555609033636
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb8b5c99c57ec083d307a96
type: string
modified:
example: 1555609033636
type: number
format: int64
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Custom
type: string
updated:
example: false
type: boolean
type: object
type: array
taxType:
example: Inherit
type: string
thc:
example: 15
type: number
thca:
example: 0
type: number
unitPrice:
example: 40
type: number
unitValue:
example: 1
type: number
updated:
example: false
type: boolean
vendor:
properties:
active:
example: true
type: boolean
additionalAddressList:
items:
type: string
type: array
address:
properties:
address:
example: ""
type: string
city:
example: ""
type: string
companyId:
example: string
type: string
country:
example: US
type: string
created:
example: 1552071418457
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5c82bafa4442190831bcd512
type: string
modified:
example: 1552071418457
type: number
format: int64
state:
example: ""
type: string
updated:
example: false
type: boolean
zipCode:
example: ""
type: string
type: object
armsLengthType:
example: ARMS_LENGTH
type: string
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
type: number
format: int64
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
backOrderEnabled:
example: false
type: boolean
brands:
example:
- 5cba942502aeca080e3b11e3
items:
type: string
type: array
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
companyLicenses:
items:
properties:
companyType:
example: RETAILER
type: string
created:
example: 1556175123774
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cc159132a77f44828c02d8b
type: string
licenseExpirationDate:
example: 0
type: number
licenseNumber:
example: ""
type: string
licenseType:
example: string
type: string
modified:
example: 1556175123774
type: number
format: int64
toDefault:
example: true
type: boolean
updated:
example: false
type: boolean
type: object
type: array
companyType:
example: string
type: string
created:
example: 1552071418457
format: int64
type: number
credits:
example: 0
type: number
dbaName:
example: string
type: string
deleted:
example: false
type: boolean
description:
example: ""
type: string
email:
example: ""
type: string
fax:
example: ""
type: string
firstName:
example: Dom
type: string
id:
example: 5c82bafa4442190831bcd513
type: string
importId:
example: string
type: string
lastName:
example: ""
type: string
licenceType:
example: string
type: string
licenseExpirationDate:
example: 0
type: number
licenseNumber:
example: ""
type: string
mobileNumber:
example: string
type: string
modified:
example: 1556175123774
type: number
format: int64
name:
example: Lowell Herb Co / The Hacienda Co LLC
type: string
notes:
items:
type: string
type: array
phone:
example: ""
type: string
qbDesktopRef:
example: string
type: string
qbVendorRef:
items:
type: string
type: array
relatedEntity:
example: false
type: boolean
updated:
example: false
type: boolean
vendorKey:
example: NWM3ZThjN2I3MjJlZDYwN2U2MWVkYjA2X2xvd2VsbCBoZXJiIGNvIC8gdGhlIGhhY2llbmRhIGNvIGxsYw==
type: string
vendorType:
example: VENDOR
type: string
website:
example: ""
type: string
type: object
vendorId:
example: 5c82bafa4442190831bcd513
type: string
weightPerUnit:
example: EIGHTH
type: string
type: object
ProductsResponse:
properties:
limit:
example: 200
type: number
skip:
example: 0
type: number
total:
example: 2
type: number
values:
items:
properties:
active:
example: true
type: boolean
assets:
example:
- string
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
type: number
format: int64
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
automaticReOrder:
example: false
type: boolean
brand:
example: string
type: string
brandId:
example: string
type: string
bundleItems:
example:
- string
items:
type: string
type: array
byGram:
example: true
type: boolean
byPrepackage:
example: false
type: boolean
cannabisType:
example: DEFAULT
type: string
category:
properties:
active:
example: true
type: boolean
cannabis:
example: true
type: boolean
cannabisType:
example: DEFAULT
type: string
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554764986388
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cabd4ba6218d148395b405b
type: string
lowThreshold:
example: string
type: string
modified:
example: 1554764986388
format: int64
type: number
name:
example: Flowers
type: string
photo:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554764986388
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cabd4ba6218d148395b404f
type: string
key:
example: 420default-Flower.jpg
type: string
largeURL:
example: string
type: string
largeX2URL:
example: string
type: string
mediumURL:
example: string
type: string
modified:
example: 1554764986388
format: int64
type: number
name:
example: Flower.jpg
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: "https://s3.amazonaws.com/connect-files-public/420default-Flower.jpg"
type: string
secured:
example: false
type: boolean
thumbURL:
example: string
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
priority:
example: 0
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
unitType:
example: grams
type: string
updated:
example: false
type: boolean
type: object
categoryId:
example: 5cabd4ba6218d148395b405b
type: string
cbd:
example: 0
type: number
cbda:
example: 0
type: number
cbn:
example: 0
type: number
companyId:
example: 5cabd4ba6218d148395b402c
type: string
companyLinkId:
example: VEIxMFBSTzE=
type: string
created:
example: 1554825555219
format: int64
type: number
customGramType:
example: GRAM
type: string
customTaxInfo:
example: string
type: string
customWeight:
example: 0
type: number
deleted:
example: false
type: boolean
description:
example: ""
type: string
dirty:
example: false
type: boolean
discountable:
example: true
type: boolean
enableExciseTax:
example: false
type: boolean
enableMixMatch:
example: false
type: boolean
enableWeedmap:
example: false
type: boolean
flowerType:
example: Sativa
type: string
genetics:
example: string
type: string
id:
example: 5cacc1536218d174d3f17b10
type: string
importId:
example: string
type: string
importSrc:
example: string
type: string
lowInventoryNotification:
example: false
type: boolean
lowThreshold:
example: 0
type: number
medicalConditions:
example:
- string
items:
type: string
type: array
medicinal:
example: true
type: boolean
modified:
example: 1554942857511
format: int64
type: number
name:
example: Binsky Flower
type: string
notes:
example:
- string
items:
type: string
type: array
potency:
example: false
type: boolean
potencyAmount:
example: string
type: string
priceBreaks:
example:
- "1234"
items:
type: string
type: array
priceIncludesALExcise:
example: false
type: boolean
priceIncludesExcise:
example: false
type: boolean
priceRanges:
items:
properties:
id:
example: 5cacc1536218d174d3f17b10_5cabd4ba6218d148395b402e
type: string
price:
example: 10
type: number
priority:
example: 0
type: number
weightTolerance:
properties:
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554746451739
format: int64
type: number
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 0.6
type: number
id:
example: 5cabd4ba6218d148395b402e
type: string
modified:
example: 1554746451739
format: int64
type: number
name:
example: .5 Gram
type: string
priority:
example: 0
type: number
startWeight:
example: 0.5
type: number
unitValue:
example: 0.5
type: number
updated:
example: false
type: boolean
weightKey:
example: HALF_GRAM
type: string
weightValue:
example: 0.5
type: number
type: object
weightToleranceId:
example: 5cabd4ba6218d148395b402e
type: string
type: object
type: array
pricingTemplateId:
example: string
type: string
productSaleType:
example: Both
type: string
productType:
example: REGULAR
type: string
qbDesktopItemRef:
example: string
type: string
qbItemRef:
example: string
type: string
quantities:
items:
properties:
companyId:
example: 5cabd4ba6218d148395b402c
type: string
created:
example: 1554825661504
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cacc1bd6218d174d3f17b38
type: string
inventoryId:
example: 5cabd4ba6218d148395b4067
type: string
modified:
example: 1554825661504
format: int64
type: number
quantity:
example: 890
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
updated:
example: false
type: boolean
type: object
type: array
reOrderLevel:
example: 0
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
showInWidget:
example: true
type: boolean
sku:
example: TB10PRO1
type: string
tags:
example:
- string
items:
type: string
type: array
taxOrder:
example: PostTaxed
type: string
taxTables:
example:
- string
items:
type: string
type: array
taxType:
example: Inherit
type: string
thc:
example: 0
type: number
thca:
example: 0
type: number
unitPrice:
example: 0
type: number
unitValue:
example: 1
type: number
updated:
example: false
type: boolean
vendor:
example: string
type: string
vendorId:
example: 5cacc0c66218d174d3f17b0d
type: string
weightPerUnit:
example: EACH
type: string
type: object
type: array
type: object
PurchaseOrderListResponse:
properties:
afterDate:
example: 0
type: number
beforeDate:
example: 1554944967088
format: int64
type: number
limit:
example: 200
type: number
skip:
example: 0
type: number
total:
example: 2
type: number
values:
items:
properties:
amountPaid:
example: 0
type: number
approvedBy:
example: 5cabd6e96218d148395b408b
type: string
approvedByMember:
properties:
address:
properties:
address:
example: 2342 Shattuck Ave Ste 182
type: string
city:
example: Berkeley
type: string
companyId:
example: 5cabd4ba6218d148395b4043
type: string
country:
example: US
type: string
created:
example: 1554765545438
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cabd6e96218d148395b408a
type: string
modified:
example: 1554765545438
format: int64
type: number
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "94704"
type: string
type: object
appAccessList:
example:
- AuthenticationApp
- Distribution
- Retail
items:
type: string
type: array
assignedInventoryId:
example: string
type: string
assignedTerminalId:
example: string
type: string
canApplyCustomDiscount:
example: false
type: boolean
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554765545438
format: int64
type: number
deleted:
example: false
type: boolean
disabled:
example: false
type: boolean
dlExpirationDate:
example: string
type: string
driversLicense:
example: string
type: string
email:
example: vern@taxnexus.net
type: string
employeeOnFleetInfoList:
example: string
type: string
firstName:
example: Vernon
type: string
id:
example: 5cabd6e96218d148395b408b
type: string
insuranceCompanyName:
example: string
type: string
insuranceExpireDate:
example: 0
type: number
lastLoggedInShopId:
example: 5cabd4ba6218d148395b4043
type: string
lastName:
example: Keenan
type: string
modified:
example: 1554942481145
format: int64
type: number
notes:
example:
- string
items:
type: string
type: array
password:
example: UbMkbvcx9ui2Bjhu3M/eoPyvJCo5VGBj
type: string
phoneNumber:
example: (510) 679-1900
type: string
pin:
example: "1234"
type: string
policyNumber:
example: string
type: string
recentLocation:
example: string
type: string
registrationExpireDate:
example: 0
type: number
role:
example: string
type: string
roleId:
example: 5cabd4ba6218d148395b403b
type: string
shops:
example:
- 5cabd4ba6218d148395b4043
items:
type: string
type: array
timeCard:
example: string
type: string
timecardId:
example: 5cae8a116218d13275d36c45
type: string
tookanInfoList:
example: string
type: string
updated:
example: false
type: boolean
vehicleLicensePlate:
example: string
type: string
vehicleMake:
example: string
type: string
vehicleModel:
example: string
type: string
vehiclePin:
example: string
type: string
vinNo:
example: string
type: string
type: object
approvedDate:
example: 1554942803672
format: int64
type: number
approvedSignature:
example: string
type: string
archive:
example: false
type: boolean
archiveDate:
example: string
type: string
companyAssetList:
example:
- string
items:
type: string
type: array
companyId:
example: 5cabd4ba6218d148395b4043
type: string
companyLogo:
example: "https://connect-assets.s3.amazonaws.com/email/logo.jpg"
type: string
completedByEmployeeId:
example: 5cabd6e96218d148395b408b
type: string
completedDate:
example: 1554942856343
format: int64
type: number
created:
example: 1554938213635
format: int64
type: number
createdByEmployeeId:
example: 5cabd6e96218d148395b408b
type: string
customTermDate:
example: 1554938121828
format: int64
type: number
customerType:
example: VENDOR
type: string
declineDate:
example: string
type: string
declineReason:
example: string
type: string
deleted:
example: false
type: boolean
deliveredBy:
example: string
type: string
deliveryAddress:
example: string
type: string
deliveryCharge:
example: 0
type: number
deliveryDate:
example: 0
type: number
deliveryTime:
example: string
type: string
dirty:
example: false
type: boolean
discount:
example: 0
type: number
dueDate:
example: 1557530213629
type: number
enableDeliveryCharge:
example: false
type: boolean
fees:
example: 0
type: number
flowerSourceType:
example: CULTIVATOR_DIRECT
type: string
grandTotal:
example: 7936
type: number
id:
example: 5cae79656218d13275d36bf4
type: string
licenseId:
example: string
type: string
managerReceiveSignature:
example: string
type: string
manualClose:
example: false
type: boolean
modified:
example: 1554942856353
format: int64
type: number
notes:
example: string
type: string
parentPOId:
example: string
type: string
parentPONumber:
example: string
type: string
poActivityLog:
items:
properties:
activityType:
example: NORMAL_LOG
type: string
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554938213660
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
employeeId:
example: 5cabd6e96218d148395b408b
type: string
id:
example: 5cae79656218d13275d36bf5
type: string
log:
example: Created PO
type: string
modified:
example: 1554938213660
format: int64
type: number
purchaseOrderId:
example: 5cae79656218d13275d36bf4
type: string
shopId:
example: 5cabd4ba6218d148395b4043
type: string
updated:
example: false
type: boolean
type: object
type: array
poNumber:
example: 2-N
type: string
poPaymentOptions:
example: CASH
type: string
poPaymentTerms:
example: NET_30
type: string
poProductRequestList:
example: string
type: string
poProductRequestResultList:
items:
properties:
batchAddDetails:
example: string
type: string
batchQuantityMap:
example: object
type: string
cannabis:
example: false
type: boolean
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554938213630
format: int64
type: number
declineReason:
example: string
type: string
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
exciseTax:
example: 1.92
type: number
id:
example: 5cae79656218d13275d36bf2
type: string
modified:
example: 1554938213630
format: int64
type: number
notes:
example: string
type: string
product:
properties:
active:
example: true
type: boolean
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
type: number
format: int64
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
automaticReOrder:
example: false
type: boolean
brand:
example: string
type: string
brandId:
example: string
type: string
bundleItems:
example:
- string
items:
type: string
type: array
byGram:
example: true
type: boolean
byPrepackage:
example: false
type: boolean
cannabisType:
example: string
type: string
category:
properties:
active:
example: true
type: boolean
cannabis:
example: true
type: boolean
cannabisType:
example: DEFAULT
type: string
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554764986388
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cabd4ba6218d148395b405b
type: string
lowThreshold:
example: string
type: string
modified:
example: 1554764986388
format: int64
type: number
name:
example: Flowers
type: string
photo:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554764986388
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cabd4ba6218d148395b404f
type: string
key:
example: 420default-Flower.jpg
type: string
largeURL:
example: string
type: string
largeX2URL:
example: string
type: string
mediumURL:
example: string
type: string
modified:
example: 1554764986388
format: int64
type: number
name:
example: Flower.jpg
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: "https://s3.amazonaws.com/connect-files-public/420default-Flower.jpg"
type: string
secured:
example: false
type: boolean
thumbURL:
example: string
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
priority:
example: 0
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
unitType:
example: grams
type: string
updated:
example: false
type: boolean
type: object
categoryId:
example: 5cabd4ba6218d148395b405b
type: string
cbd:
example: 0
type: number
cbda:
example: 0
type: number
cbn:
example: 0
type: number
companyId:
example: 5cabd4ba6218d148395b4043
type: string
companyLinkId:
example: string
type: string
created:
example: 1554825555219
format: int64
type: number
customGramType:
example: string
type: string
customTaxInfo:
example: string
type: string
customWeight:
example: 0
type: number
deleted:
example: false
type: boolean
description:
example: string
type: string
dirty:
example: false
type: boolean
discountable:
example: true
type: boolean
enableExciseTax:
example: false
type: boolean
enableMixMatch:
example: false
type: boolean
enableWeedmap:
example: false
type: boolean
flowerType:
example: Sativa
type: string
genetics:
example: string
type: string
id:
example: 5cacc1536218d174d3f17b10
type: string
importId:
example: string
type: string
importSrc:
example: string
type: string
lowInventoryNotification:
example: false
type: boolean
lowThreshold:
example: 0
type: number
medicalConditions:
example:
- string
items:
type: string
type: array
medicinal:
example: true
type: boolean
modified:
example: 1554942857511
format: int64
type: number
name:
example: Binsky Flower
type: string
notes:
example:
- string
items:
type: string
type: array
potency:
example: false
type: boolean
potencyAmount:
example: string
type: string
priceBreaks:
example:
- string
items:
type: string
type: array
priceIncludesALExcise:
example: false
type: boolean
priceIncludesExcise:
example: false
type: boolean
priceRanges:
items:
properties:
id:
example: 5cacc1536218d174d3f17b10_5cabd4ba6218d148395b402e
type: string
price:
example: 10
type: number
priority:
example: 0
type: number
weightTolerance:
properties:
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554746451739
format: int64
type: number
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 0.6
type: number
id:
example: 5cabd4ba6218d148395b402e
type: string
modified:
example: 1554746451739
format: int64
type: number
name:
example: .5 Gram
type: string
priority:
example: 0
type: number
startWeight:
example: 0.5
type: number
unitValue:
example: 0.5
type: number
updated:
example: false
type: boolean
weightKey:
example: HALF_GRAM
type: string
weightValue:
example: 0.5
type: number
type: object
weightToleranceId:
example: 5cabd4ba6218d148395b402e
type: string
type: object
type: array
pricingTemplateId:
example: string
type: string
productSaleType:
example: Both
type: string
productType:
example: string
type: string
qbDesktopItemRef:
example: string
type: string
qbItemRef:
example: string
type: string
quantities:
items:
properties:
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554825661504
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cacc1bd6218d174d3f17b38
type: string
inventoryId:
example: 5cabd4ba6218d148395b4067
type: string
modified:
example: 1554825661504
format: int64
type: number
quantity:
example: 890
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
updated:
example: false
type: boolean
type: object
type: array
reOrderLevel:
example: 0
type: number
shopId:
example: 5cabd4ba6218d148395b4043
type: string
showInWidget:
example: true
type: boolean
sku:
example: TB10PRO1
type: string
tags:
example:
- string
items:
type: string
type: array
taxOrder:
example: PostTaxed
type: string
taxTables:
example:
- string
items:
type: string
type: array
taxType:
example: Inherit
type: string
thc:
example: 0
type: number
thca:
example: 0
type: number
unitPrice:
example: 0
type: number
unitValue:
example: 1
type: number
updated:
example: false
type: boolean
vendor:
example: string
type: string
vendorId:
example: 5cacc0c66218d174d3f17b0d
type: string
weightPerUnit:
example: EACH
type: string
type: object
productId:
example: 5cacc1536218d174d3f17b10
type: string
productName:
example: Binsky Flower
type: string
receiveBatchStatus:
example: READY_FOR_SALE
type: string
receivedQuantity:
example: 800
type: number
requestQuantity:
example: 800
type: number
requestStatus:
example: ACCEPTED
type: string
shopId:
example: 5cabd4ba6218d148395b4043
type: string
totalCost:
example: 6400
type: number
totalCultivationTax:
example: 0
type: number
totalExciseTax:
example: 1536
type: number
trackTraceSystem:
example: string
type: string
trackingPackagesList:
example:
- string
items:
type: string
type: array
unitPrice:
example: 8
type: number
updated:
example: false
type: boolean
type: object
type: array
poQrCodeAsset:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5cabd4ba6218d148395b4043
type: string
created:
example: 1554938213885
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cae79656218d13275d36bf6
type: string
key:
example: 5cae79656218d13275d36bf4-2-N.png
type: string
largeURL:
example: string
type: string
largeX2URL:
example: string
type: string
mediumURL:
example: string
type: string
modified:
example: 1554938213885
format: int64
type: number
name:
example: Invoice
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: "https://connect-files-public.s3.amazonaws.com/5cae79656218d13275d36bf4-2-N.png"
type: string
secured:
example: false
type: boolean
thumbURL:
example: string
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
poQrCodeUrl:
example: "https://connect-files-public.s3.amazonaws.com/5cae79656218d13275d36bf4-2-N.png"
type: string
poType:
example: Normal
type: string
podueDate:
example: 1557530213635
format: int64
type: number
purchaseOrderDate:
example: 0
type: number
purchaseOrderStatus:
example: Closed
type: string
qbPurchaseOrderRef:
example: string
type: string
receivedByEmployeeId:
example: 5cabd6e96218d148395b408b
type: string
receivedDate:
example: 1554942839629
format: int64
type: number
reference:
example: string
type: string
shipmentBillId:
example: 5cae8b886218d13275d36c59
type: string
shopId:
example: 5cabd4ba6218d148395b4043
type: string
submitForApprovalDate:
example: 1554938214072
format: int64
type: number
taxResult:
properties:
created:
example: 1554942856352
format: int64
type: number
cultivationTaxResult:
properties:
flowerTaxOz:
example: 0
type: number
leafTaxOz:
example: 0
type: number
totalCultivationTax:
example: 0
type: number
totalFlowerOz:
example: 0
type: number
totalFlowerTax:
example: 0
type: number
totalLeafOz:
example: 0
type: number
totalLeafTax:
example: 0
type: number
type: object
deleted:
example: false
type: boolean
id:
example: 5cae8b886218d13275d36c5a
type: string
modified:
example: 1554942856352
format: int64
type: number
totalALExciseTax:
example: 0
type: number
totalALPostExciseTax:
example: 0
type: number
totalCityPreTax:
example: 0
type: number
totalCityTax:
example: 0
type: number
totalCountyPreTax:
example: 0
type: number
totalCountyTax:
example: 0
type: number
totalExciseTax:
example: 1536
type: number
totalFedPreTax:
example: 0
type: number
totalFedTax:
example: 0
type: number
totalNALPreExciseTax:
example: 0
type: number
totalPostCalcTax:
example: 0
type: number
totalPreCalcTax:
example: 0
type: number
totalStatePreTax:
example: 0
type: number
totalStateTax:
example: 0
type: number
updated:
example: false
type: boolean
type: object
termsAndCondition:
example: string
type: string
totalCalcTax:
example: 0
type: number
totalCost:
example: 6400
type: number
totalPreCalcTax:
example: 0
type: number
totalTax:
example: 1536
type: number
transactionType:
example: ARMS_LENGTH
type: string
updated:
example: false
type: boolean
vendor:
properties:
active:
example: true
type: boolean
additionalAddressList:
example:
- string
items:
type: string
type: array
address:
properties:
address:
example: string
type: string
city:
example: string
type: string
companyId:
example: string
type: string
country:
example: US
type: string
created:
example: 1554825414778
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cacc0c66218d174d3f17b0c
type: string
modified:
example: 1554825414778
format: int64
type: number
state:
example: string
type: string
updated:
example: false
type: boolean
zipCode:
example: string
type: string
type: object
armsLengthType:
example: ARMS_LENGTH
type: string
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
type: number
format: int64
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
backOrderEnabled:
example: false
type: boolean
brands:
example:
- string
items:
type: string
type: array
companyId:
example: 5cabd4ba6218d148395b4043
type: string
companyLicenses:
items:
type: string
type: array
companyType:
example: string
type: string
created:
example: 1554825414778
format: int64
type: number
credits:
example: 0
type: number
dbaName:
example: string
type: string
deleted:
example: false
type: boolean
description:
example: string
type: string
email:
example: string
type: string
fax:
example: string
type: string
firstName:
example: string
type: string
id:
example: 5cacc0c66218d174d3f17b0d
type: string
importId:
example: string
type: string
lastName:
example: string
type: string
licenceType:
example: string
type: string
licenseExpirationDate:
example: 0
type: number
licenseNumber:
example: string
type: string
mobileNumber:
example: string
type: string
modified:
example: 1554825414778
format: int64
type: number
name:
example: Binsky
type: string
notes:
example:
- string
items:
type: string
type: array
phone:
example: string
type: string
qbDesktopRef:
example: string
type: string
qbVendorRef:
example:
- string
items:
type: string
type: array
relatedEntity:
example: false
type: boolean
updated:
example: false
type: boolean
vendorKey:
example: NWNhYmQ0YmE2MjE4ZDE0ODM5NWI0MDJjX2JpbnNreQ==
type: string
vendorType:
example: VENDOR
type: string
website:
example: string
type: string
type: object
vendorId:
example: 5cacc0c66218d174d3f17b0d
type: string
type: object
type: array
type: object
ShopResponse:
properties:
companyLogoURL:
example: "https://connect-files-public.s3.amazonaws.com/1d405589-9408-4f00-8b00-b30bfbc636d1.png"
type: string
shop:
properties:
active:
example: true
type: boolean
address:
properties:
address:
example: 695 Williams Rd
type: string
addressLine1:
example: ""
type: string
city:
example: Palm Springs
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
country:
example: US
type: string
created:
example: 1553982501824
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5c9fe425e0faca07db94b971
type: string
modified:
example: 1553982501824
type: number
format: int64
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "92264"
type: string
type: object
ageLimit:
example: 21
type: number
alExciseOnZeroPrice:
example: true
type: boolean
allowAnonymousOrders:
example: false
type: boolean
appTarget:
example: Retail
type: string
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Document
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1558145178150
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cdf689a59ded8080e03c06a
type: string
key:
example: f5777926-e5cd-48c3-a026-a527bfaa930f.pdf
type: string
largeURL:
example: string
type: string
largeX2URL:
example: string
type: string
mediumURL:
example: string
type: string
modified:
example: 1558145178150
type: number
format: int64
name:
example: CGI Sellers Permit 247130880 - 00001.pdf
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: string
type: string
secured:
example: true
type: boolean
thumbURL:
example: string
type: string
type:
example: Document
type: string
updated:
example: false
type: boolean
type: object
type: array
autoCashDrawer:
example: false
type: boolean
bccEmailAddress:
example: info@pineappleexpress.com
type: string
cartMinimums:
properties:
cartMinimumDetails:
items:
properties:
enabled:
example: true
type: boolean
minimum:
example: 40
type: number
type: object
type: array
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1553984069346
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5c9fea45b8bccf07fc47d5cc
type: string
minimumsType:
example: SIMPLE
type: string
modified:
example: 1553984069346
type: number
format: int64
updated:
example: false
type: boolean
type: object
checkoutType:
example: Direct
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1553982501824
type: number
format: int64
creditFefundType:
example: NONE
type: string
defaultCountry:
example: US
type: string
defaultPinTimeout:
example: 5
type: number
deleted:
example: false
type: boolean
deliveryFee:
example: 0
type: number
deliveryRefundType:
example: NONE
type: string
emailAdress:
example: support@pineappleexpress.com
type: string
emailMessage:
example: string
type: string
enableAgeLimit:
example: true
type: boolean
enableBCCReceipt:
example: true
type: boolean
enableCannabisLimit:
example: true
type: boolean
enableCashInOut:
example: false
type: boolean
enableDailySummaryEmail:
example: false
type: boolean
enableDeliveryFee:
example: false
type: boolean
enableDeliverySignature:
example: true
type: boolean
enableExciseTax:
example: true
type: boolean
enableGPSTracking:
example: true
type: boolean
enableHarvestTax:
example: false
type: boolean
enableLowInventoryEmail:
example: true
type: boolean
enableMedicinalAge:
example: true
type: boolean
enableOnFleet:
example: true
type: boolean
enablePinForCashDrawer:
example: false
type: boolean
enableSaleLogout:
example: false
type: boolean
enableSpringBig:
example: false
type: boolean
enableTookan:
example: false
type: boolean
enableWooCommerce:
example: false
type: boolean
enforceCashDrawers:
example: true
type: boolean
exciseTaxType:
example: TOTAL_AMOUNT
type: string
hubId:
example: JPowoWy*p6zFD5D*y9t77DNJ
type: string
hubName:
example: Palm Springs
type: string
id:
example: 5c9fe425e0faca07db94b970
type: string
invoiceNote:
example: string
type: string
invoiceTermCondition:
example: string
type: string
latitude:
example: 0
type: number
legalLanguage:
example:
"WARNING: This product can expose you to marijuana smoke
and myrcene, which are known to the State of California to
cause cancer. For more information, go to
www.P65Warnings.ca.gov."
type: string
license:
example: C9-18-0000102-TEMP
type: string
logo:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1555870891770
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cbcb4ab85c8ac07ed72aac0
type: string
key:
example: 5d145b98-e563-40ec-bf50-189fa275888d.jpg
type: string
largeURL:
example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-800x800.jpg"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-1600x1600.jpg"
type: string
mediumURL:
example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-500x500.jpg"
type: string
modified:
example: 1555870891770
type: number
format: int64
name:
example: PE New.jpg
type: string
origURL:
example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d.jpg"
type: string
priority:
example: 0
type: number
publicURL:
example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d.jpg"
type: string
secured:
example: false
type: boolean
thumbURL:
example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-200x200.jpg"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
longitude:
example: 0
type: number
marketingSources:
example:
- On Deck
- Weed Maps
- Google
- Personal Referral
- Billboard
- Social Media
- Print Media
- Other
items:
type: string
type: array
medicinalAge:
example: 18
type: number
membersCountSyncDate:
example: 1558372668851
type: number
membersTag:
example:
- Disabled
items:
type: string
type: array
modified:
example: 1558372668851
type: number
format: int64
nalExciseFromRetailCost:
example: false
type: boolean
name:
example: Pineapple Express Palm Springs
type: string
nextSnapshotTime:
example: 1558422300000
type: number
format: int64
numAllowActiveTrans:
example: 1
type: number
onFleetApiKey:
example: d3ba42b1b557f703910d53d1a45be8ed
type: string
onFleetOrganizationId:
example: ziXWVNJiLeB2IeMUN5kSdIkX
type: string
onFleetOrganizationName:
example: Pineapple Express
type: string
onlineStoreInfo:
properties:
activeInventoryId:
example: string
type: string
cartMinType:
example: SubtotalWithDiscount
type: string
cartMinimum:
example: 0
type: number
colorTheme:
example: Light
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1553984069346
type: number
format: int64
customMessageETA:
example: string
type: string
defaultETA:
example: 90
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
enableDelivery:
example: true
type: boolean
enableDeliveryAreaRestrictions:
example: true
type: boolean
enableHtmlText:
example: false
type: boolean
enableInventory:
example: false
type: boolean
enableInventoryType:
example: Custom
type: string
enableOnlinePOS:
example: true
type: boolean
enableOnlineShipment:
example: false
type: boolean
enableOtherMarketingSource:
example: false
type: boolean
enableProductReviews:
example: true
type: boolean
enableStorePickup:
example: false
type: boolean
enabled:
example: true
type: boolean
htmlText:
example: string
type: string
id:
example: 5c9fea45b8bccf07fc47d5cd
type: string
modified:
example: 1553984069346
type: number
format: int64
pageOneMessageBody:
example: string
type: string
pageOneMessageTitle:
example: string
type: string
restrictedZipCodes:
example:
- "90895"
- "91001"
- "91006"
- "91007"
- "93063"
items:
type: string
type: array
shopId:
example: 5c9fe425e0faca07db94b970
type: string
storeHexColor:
example: string
type: string
submissionMessage:
example: string
type: string
supportEmail:
example: support@pineappleexpress.com
type: string
updated:
example: false
type: boolean
useCustomETA:
example: false
type: boolean
viewType:
example: List
type: string
websiteOrigins:
example: ""
type: string
websiteUrl:
example: "https://pineappleexpress.com"
type: string
type: object
orderTags:
example:
- Appointment
- Early Bird
- Late Gift
items:
type: string
type: array
phoneNumber:
example: (877) 933-3548
type: string
poNote:
example: string
type: string
poTermCondition:
example: string
type: string
productPriceIncludeExciseTax:
example: false
type: boolean
productsTag:
example:
- Flower
- Concentrate
- Edibles
- Vegan
- vegan
- Preroll
- Vape Pens
- Topical
- Wraps
items:
type: string
type: array
receiptInfo:
items:
properties:
aboveFreeText:
example: TOP OF RECEIPT TEXT GOES HERE.
type: string
companyId:
example: string
type: string
created:
example: 1557103750658
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
enableBrand:
example: false
type: boolean
enableEmployeeName:
example: true
type: boolean
enableExciseTaxAsItem:
example: true
type: boolean
enableIncludeItemInSKU:
example: false
type: boolean
enableMemberAddress:
example: false
type: boolean
enableMemberId:
example: false
type: boolean
enableMemberLoyaltyPoints:
example: true
type: boolean
enableMemberName:
example: true
type: boolean
enableNotes:
example: false
type: boolean
enableShopAddress:
example: false
type: boolean
enableShopPhoneNo:
example: true
type: boolean
enabledBottomFreeText:
example: false
type: boolean
enabledFreeText:
example: false
type: boolean
freeText:
example: BOTTOM OF RECEIPT TEXT GOES HERE.
type: string
id:
example: string
type: string
modified:
example: 1557103750658
type: number
format: int64
receiptType:
example: SALES
type: string
shopId:
example: string
type: string
updated:
example: false
type: boolean
type: object
type: array
receivingInventoryId:
example: 5c9fe425e0faca07db94b990
type: string
requireValidRecDate:
example: true
type: boolean
restrictIncomingOrderNotifications:
example: true
type: boolean
restrictedNotificationTerminals:
example:
- 5c82b36db4ab160827412e62
- 5c82b3944442190831bca731
- 5cb7d5f54cd84907f647b6cd
items:
type: string
type: array
restrictedViews:
example: true
type: boolean
roundOffType:
example: NONE
type: string
roundUpMessage:
example: string
type: string
shopType:
example: Both
type: string
shortIdentifier:
example: string
type: string
showDeliveryQueue:
example: true
type: boolean
showOnlineQueue:
example: false
type: boolean
showProductByAvailableQuantity:
example: true
type: boolean
showSpecialQueue:
example: false
type: boolean
showWalkInQueue:
example: false
type: boolean
snapshopTime:
example: 1558336185744
type: number
format: int64
taxInfo:
properties:
cityTax:
example: 0
type: number
created:
example: 1553984069346
type: number
format: int64
deleted:
example: false
type: boolean
federalTax:
example: 0
type: number
id:
example: 5c9fea45b8bccf07fc47d5ce
type: string
modified:
example: 1553984069346
type: number
format: int64
stateTax:
example: 0.08
type: number
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxRoundOffType:
example: ONE_CENT
type: string
taxTables:
items:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: string
type: string
compound:
example: false
type: boolean
created:
example: 1555534297286
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb791d92f7a85083f3638ad
type: string
modified:
example: 1555534297286
type: number
format: int64
shopId:
example: string
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: AdultUse
type: string
countyTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: string
type: string
compound:
example: true
type: boolean
created:
example: 1555534297286
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb791d92f7a85083f3638ae
type: string
modified:
example: 1555534297286
type: number
format: int64
shopId:
example: string
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0.25
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1553984069346
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: string
type: string
compound:
example: false
type: boolean
created:
example: 1555534297286
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb791d92f7a85083f3638b0
type: string
modified:
example: 1555534297286
type: number
format: int64
shopId:
example: string
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5c9fea45b8bccf07fc47d5c9
type: string
modified:
example: 1553984069346
type: number
format: int64
name:
example: Adult Use
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
stateTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: string
type: string
compound:
example: true
type: boolean
created:
example: 1555534297286
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cb791d92f7a85083f3638af
type: string
modified:
example: 1555534297286
type: number
format: int64
shopId:
example: string
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 9.25
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Inherit
type: string
updated:
example: false
type: boolean
type: object
type: array
timeZone:
example: America/Los_Angeles
type: string
timezoneOffsetInMinutes:
example: -420
type: number
twilioNumber:
example: string
type: string
updated:
example: false
type: boolean
useAssignedEmployee:
example: false
type: boolean
useComplexTax:
example: true
type: boolean
type: object
toleranceMap:
properties:
GRAM:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486903
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 1.35
type: number
id:
example: 5c7e8c7b722ed607e61edb09
type: string
modified:
example: 1551488486903
type: number
format: int64
name:
example: Gram
type: string
priority:
example: 1
type: number
startWeight:
example: 0.85
type: number
unitValue:
example: 1
type: number
updated:
example: false
type: boolean
weightKey:
example: GRAM
type: string
weightValue:
example: 1
type: number
type: object
HALF:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486905
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 14.5
type: number
id:
example: 5c7e8c7b722ed607e61edb0e
type: string
modified:
example: 1551488486905
type: number
format: int64
name:
example: 1/2
type: string
priority:
example: 6
type: number
startWeight:
example: 14
type: number
unitValue:
example: 14
type: number
updated:
example: false
type: boolean
weightKey:
example: HALF
type: string
weightValue:
example: 14.17476
type: number
type: object
HALF_GRAM:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486902
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 0.6
type: number
id:
example: 5c7e8c7b722ed607e61edb08
type: string
modified:
example: 1551488486902
type: number
format: int64
name:
example: .5 Gram
type: string
priority:
example: 0
type: number
startWeight:
example: 0.5
type: number
unitValue:
example: 0.5
type: number
updated:
example: false
type: boolean
weightKey:
example: HALF_GRAM
type: string
weightValue:
example: 0.5
type: number
type: object
ONE_EIGHTTH:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486905
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 3.85
type: number
id:
example: 5c7e8c7b722ed607e61edb0c
type: string
modified:
example: 1551488486905
type: number
format: int64
name:
example: 1/8th
type: string
priority:
example: 4
type: number
startWeight:
example: 3.45
type: number
unitValue:
example: 3.5
type: number
updated:
example: false
type: boolean
weightKey:
example: ONE_EIGHTTH
type: string
weightValue:
example: 3.54369
type: number
type: object
OUNCE:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486905
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 28.5
type: number
id:
example: 5c7e8c7b722ed607e61edb0f
type: string
modified:
example: 1551488486905
type: number
format: int64
name:
example: 1 Oz
type: string
priority:
example: 7
type: number
startWeight:
example: 28
type: number
unitValue:
example: 28
type: number
updated:
example: false
type: boolean
weightKey:
example: OUNCE
type: string
weightValue:
example: 28.34952
type: number
type: object
QUARTER:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486905
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 7.5
type: number
id:
example: 5c7e8c7b722ed607e61edb0d
type: string
modified:
example: 1551488486905
format: int64
type: number
name:
example: 1/4th
type: string
priority:
example: 5
type: number
startWeight:
example: 7
type: number
unitValue:
example: 7
type: number
updated:
example: false
type: boolean
weightKey:
example: QUARTER
type: string
weightValue:
example: 7.087381
type: number
type: object
THREE_GRAMS:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486904
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 3.1
type: number
id:
example: 5c7e8c7b722ed607e61edb0b
type: string
modified:
example: 1551488486904
format: int64
type: number
name:
example: 3 Grams
type: string
priority:
example: 3
type: number
startWeight:
example: 3
type: number
unitValue:
example: 3
type: number
updated:
example: false
type: boolean
weightKey:
example: THREE_GRAMS
type: string
weightValue:
example: 3
type: number
type: object
TWO_GRAMS:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486903
type: number
format: int64
deleted:
example: false
type: boolean
enabled:
example: true
type: boolean
endWeight:
example: 2.1
type: number
id:
example: 5c7e8c7b722ed607e61edb0a
type: string
modified:
example: 1551488486903
format: int64
type: number
name:
example: 2 Grams
type: string
priority:
example: 2
type: number
startWeight:
example: 2
type: number
unitValue:
example: 2
type: number
updated:
example: false
type: boolean
weightKey:
example: TWO_GRAMS
type: string
weightValue:
example: 2
type: number
type: object
type: object
type: object
TransactionByIdResponse:
properties:
active:
example: false
type: boolean
addressUpdate:
example: false
type: boolean
assigned:
example: true
type: boolean
assignedEmployeeId:
example: 5cabd4ba6218d148395b406f
type: string
cart:
properties:
adjustmentAmount:
example: 0
type: number
afterTaxDiscount:
example: 0
type: number
afterTaxDiscountNotes:
example: ""
type: string
appliedAfterTaxDiscount:
example: 0
type: number
balanceDue:
example: 0
type: number
calcCartDiscount:
example: 5.4
type: number
cartDiscountNotes:
example: ""
type: string
cashReceived:
example: 0
type: number
changeDue:
example: 0
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
created:
example: 1585432659695
type: number
format: int64
creditCardFee:
example: 0
type: number
deleted:
example: false
type: boolean
deliveryDiscount:
example: 0
type: number
deliveryDiscountType:
example: Cash
type: string
deliveryFee:
example: 0
type: number
discount:
example: 5.4
type: number
discountType:
example: Cash
type: string
enableCreditCardFee:
example: false
type: boolean
enableDeliveryFee:
example: false
type: boolean
finalRefundAmt:
example: 0
type: number
id:
example: 5e7fc85343383208d7fbac3f
type: string
items:
items:
properties:
availableDiscountQty:
example: 0
type: number
calcCultivationTax:
example: 0
type: number
calcDiscount:
example: 0
type: number
calcPreTax:
example: 0
type: number
calcTax:
example: 4.0522
type: number
cogs:
example: 7
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
cost:
example: 20.99
type: number
created:
example: 1585432681221
type: number
format: int64
deleted:
example: false
type: boolean
discount:
example: 0
type: number
discountNotes:
example: ""
type: string
discountType:
example: Cash
type: string
discountedQty:
example: 0
type: number
exciseTax:
example: 0.3686
type: number
finalPrice:
example: 20.99
type: number
finalized:
example: false
type: boolean
fulfilled:
example: true
type: boolean
id:
example: 5e7fc86913d34108c8fc6e6d
type: string
ignoreMixMatch:
example: false
type: boolean
mixMatched:
example: false
type: boolean
modified:
example: 1585440891572
type: number
format: int64
orderItemId:
example: 2022a978-4995-415d-9d8f-2cbf22766028
type: string
origQuantity:
example: 1
type: number
overridePrice:
example: 0
type: number
perUnitRefundAmt:
example: 0
type: number
preparedQty:
example: 0
type: number
productId:
example: 5de977fafe67a6082e6f2b26
type: string
promotionReqs:
items:
type: number
type: array
quantity:
example: 10
type: number
quantityLogs:
items:
properties:
batchId:
example: 5cacc1bb6218d174d3f17b31
type: string
id:
example: 1a7002e4-ac24-43a3-a84e-2c8af39aaa2a_5cabd4ba6218d148395b4067_5cacc1bb6218d174d3f17b31
type: string
inventoryId:
example: 5cabd4ba6218d148395b4067
type: string
quantity:
example: 10
type: number
type: object
type: array
status:
example: Active
type: string
taxOrder:
example: PostTaxed
type: string
taxResult:
properties:
created:
example: 1554826473345
format: int64
type: number
cultivationTaxResult:
properties:
flowerTaxOz:
example: 0
type: number
leafTaxOz:
example: 0
type: number
totalCultivationTax:
example: 0
type: number
totalFlowerOz:
example: 0
type: number
totalFlowerTax:
example: 0
type: number
totalLeafOz:
example: 0
type: number
totalLeafTax:
example: 0
type: number
type: object
deleted:
example: false
type: boolean
id:
example: 5cacc4e96218d174d3f17c3a
type: string
modified:
example: 1554826473345
format: int64
type: number
totalALExciseTax:
example: 96
type: number
totalALPostExciseTax:
example: 96
type: number
totalCityPreTax:
example: 0
type: number
totalCityTax:
example: 0
type: number
totalCountyPreTax:
example: 0
type: number
totalCountyTax:
example: 0
type: number
totalExciseTax:
example: 0
type: number
totalFedPreTax:
example: 0
type: number
totalFedTax:
example: 0
type: number
totalNALPreExciseTax:
example: 0
type: number
totalPostCalcTax:
example: 0
type: number
totalPreCalcTax:
example: 0
type: number
totalStatePreTax:
example: 0
type: number
totalStateTax:
example: 0
type: number
updated:
example: false
type: boolean
type: object
taxTable:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891598
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: City
type: string
id:
example: 5e7fe87be26bf108c9d189e2
type: string
modified:
example: 1585440891598
type: number
format: int64
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 10
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
countyTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891598
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: County
type: string
id:
example: 5e7fe87be26bf108c9d189e3
type: string
modified:
example: 1585440891598
type: number
format: int64
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1585440891598
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891598
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: Federal
type: string
id:
example: 5e7fe87be26bf108c9d189e5
type: string
modified:
example: 1585440891598
type: number
format: int64
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5e7fe87be26bf108c9d189e1
type: string
modified:
example: 1585440891598
type: number
format: int64
name:
example: Medicinal - Third Party
type: string
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
stateTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891598
type: number
format: int64
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: State
type: string
id:
example: 5e7fe87be26bf108c9d189e4
type: string
modified:
example: 1585440891598
type: number
format: int64
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 9.5
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Custom
type: string
updated:
example: false
type: boolean
type: object
taxType:
example: Inherit
type: string
totalRefundAmount:
example: 0
type: number
totalRefundQty:
example: 0
type: number
unitPrice:
example: 20.99
type: number
unitQty:
example: 0
type: number
updated:
example: false
type: boolean
useUnitQty:
example: false
type: boolean
weightKey:
example: UNIT
type: string
type: object
type: array
modified:
example: 1585440891476
type: number
format: int64
paymentOption:
example: Credit
type: string
paymentType:
example: Full
type: string
pointSpent:
example: 0
type: number
promoCode:
example: ""
type: string
promotionReqLogs:
items:
properties:
amount:
example: 5.4
type: number
assigned:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1585440891535
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5e7fe87be26bf108c9d189d9
type: string
modified:
example: 1585440891535
type: number
format: int64
promotionId:
example: 5da25bd344ce2e084b72fe31
type: string
promotionType:
example: Cart
type: string
stackable:
example: false
type: boolean
updated:
example: false
type: boolean
type: object
type: array
promotionReqs:
items:
properties:
assigned:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1585440891508
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5e7fe87be26bf108c9d189d4
type: string
modified:
example: 1585440891508
format: int64
type: number
promotionId:
example: 5da25bd344ce2e084b72fe31
type: string
updated:
example: false
type: boolean
type: object
type: array
refundAmount:
example: 0
type: number
refundOption:
example: Void
type: string
refundOrderItemRequests:
items:
type: string
type: array
requestRefundAmt:
example: 0
type: number
roundAmt:
example: 0
type: number
storageLocation:
example: CashDrawer
type: string
subTotal:
example: 334
type: number
subTotalDiscount:
example: 334
type: number
tax:
example: 0.08
type: number
taxResult:
properties:
created:
example: 1585440891598
type: number
format: int64
cultivationTaxResult:
properties:
flowerTaxOz:
example: 0
type: number
leafTaxOz:
example: 0
type: number
plantTaxOz:
example: 0
type: number
totalCultivationTax:
example: 0
type: number
totalFlowerOz:
example: 0
type: number
totalFlowerTax:
example: 0
type: number
totalLeafOz:
example: 0
type: number
totalLeafTax:
example: 0
type: number
totalPlantOz:
example: 0
type: number
totalPlantTax:
example: 0
type: number
type: object
deleted:
example: false
type: boolean
id:
example: 5e7fe87be26bf108c9d189ec
type: string
modified:
example: 1585440891598
format: int64
type: number
taxMappingInfo:
properties:
City:
example: City
type: string
County:
example: County
type: string
Federal:
example: Federal
type: string
State:
example: State
type: string
type: object
totalALExciseTax:
example: 0
type: number
totalALPostExciseTax:
example: 4.05
type: number
totalCityPreTax:
example: 0
type: number
totalCityTax:
example: 5.26
type: number
totalCountyPreTax:
example: 0
type: number
totalCountyTax:
example: 0
type: number
totalExciseTax:
example: 0
type: number
totalFedPreTax:
example: 0
type: number
totalFedTax:
example: 0
type: number
totalNALPreExciseTax:
example: 0
type: number
totalPostCalcTax:
example: 14.31
type: number
totalPreCalcTax:
example: 0
type: number
totalStatePreTax:
example: 0
type: number
totalStateTax:
example: 5
type: number
updated:
example: false
type: boolean
type: object
taxRoundOffType:
example: ONE_CENT
type: string
taxTable:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891480
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: City
type: string
id:
example: 5e7fe87be26bf108c9d189d0
type: string
modified:
example: 1585440891480
format: int64
type: number
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 10
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
countyTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891480
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: County
type: string
id:
example: 5e7fe87be26bf108c9d189d1
type: string
modified:
example: 1585440891480
format: int64
type: number
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1585440891480
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891480
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: Federal
type: string
id:
example: 5e7fe87be26bf108c9d189d3
type: string
modified:
example: 1585440891480
format: int64
type: number
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5e7fe87be26bf108c9d189cf
type: string
modified:
example: 1585440891480
type: number
format: int64
name:
example: Medicinal - Third Party
type: string
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
stateTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1585440891480
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
displayName:
example: State
type: string
id:
example: 5e7fe87be26bf108c9d189d2
type: string
modified:
example: 1585440891480
format: int64
type: number
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 9.5
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Custom
type: string
updated:
example: false
type: boolean
type: object
tipAmount:
example: 0
type: number
total:
example: 430
type: number
totalALExciseTax:
example: 0
type: number
totalCalcTax:
example: 96
type: number
totalDiscount:
example: 0
type: number
totalExciseTax:
example: 0
type: number
totalPreCalcTax:
example: 0
type: number
updated:
example: false
type: boolean
type: object
checkinTime:
example: 1585432659695
format: int64
type: number
checkoutType:
example: Direct
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
completeAfter:
example: 1585441800000
type: number
format: int64
completedTime:
example: 1585440892887
format: int64
type: number
createOnfleetTask:
example: true
type: boolean
createTookanTask:
example: false
type: boolean
created:
example: 1585432659695
format: int64
type: number
createdById:
example: 5d1109b9874b44081f07df8f
type: string
deleted:
example: false
type: boolean
deliveryAddress:
properties:
address:
example: "4331 Green Avenue "
type: string
addressLine2:
example: ""
type: string
city:
example: Los Alamitos
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
country:
example: US
type: string
created:
example: 1585432659695
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5e7fc85343383208d7fbac40
type: string
modified:
example: 1585432659695
type: number
format: int64
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "90720"
type: string
type: object
deliveryDate:
example: 1585443600000
format: int64
type: number
dirty:
example: false
type: boolean
endRouteDate:
example: 1585440891404
format: int64
type: number
endTime:
example: 1585440891404
format: int64
type: number
eta:
example: 0
type: number
fulfillingFulfillment:
example: false
type: boolean
fulfillmentStep:
example: Prepare
type: string
id:
example: 5e7fc85343383208d7fbac3e
type: string
loc:
example:
- -118.05688211705355
- 33.80187413192708
items:
type: number
type: array
locked:
example: false
type: boolean
memberId:
example: 5e7fc80143383208d7fba673
type: string
memberSignature:
properties:
active:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1585440877379
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5e7fe86dcdabfe08de901539
type: string
key:
example: e3ccaa24-63db-410b-b3aa-205259a04f52.png
type: string
largeURL:
example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-800x800.png"
type: string
mediumURL:
example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-500x500.png"
type: string
modified:
example: 1585440877379
type: number
format: int64
name:
example: file
type: string
priority:
example: 0
type: number
publicURL:
example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52.png"
type: string
secured:
example: false
type: boolean
thumbURL:
example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-200x200.png"
type: string
updated:
example: false
type: boolean
type: object
memo:
example: ""
type: string
metrcDeliverySubmitStatus:
example: None
type: string
metrcDeliverySubmitTime:
example: 0
type: number
format: int64
metrcId:
example: 17281252
type: number
metrcSaleTime:
example: "2020-03-29T00:14:52.887Z"
type: string
metrcSubmissionCompleteTime:
example: 0
type: number
format: int64
metrcSubmissionDeleteTime:
example: 0
type: number
format: int64
mileage:
example: 0
type: number
mileageCalculated:
example: true
type: boolean
modified:
example: 1585440893789
type: number
format: int64
onFleetError:
example: ""
type: string
onFleetTaskId:
example: o7XchVifXLXF40qHK1LnVijP
type: string
orderTags:
example:
- REC Verified
- Delivery
items:
type: string
type: array
overrideInventoryId:
example: 5c7e8c7b722ed607e61edb41
type: string
packedBy:
example: 5d9384eca660c70822e3b1d0
type: string
packedDate:
example: 1585432972448
type: number
paid:
example: true
type: boolean
payingWithPaymentCard:
example: false
type: boolean
paymentEditedTime:
example: 0
type: number
format: int64
pointsEarned:
example: 0
type: number
preparedBy:
example: 5d1109b9874b44081f07df8f
type: string
preparingFulfillment:
example: false
type: boolean
priority:
example: 14309
type: number
processedTime:
example: 1585440892887
type: number
format: int64
queueType:
example: Delivery
type: string
refundPaymentOptions:
example:
- Credit
- StoreCredit
items:
type: string
type: array
routing:
example: false
type: boolean
sellerId:
example: 5d1655750f9c6f07f744a78a
type: string
sellerTerminalId:
example: 5d291e02bd20bf0800b3e816
type: string
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
shortId:
example: 457d176d
type: string
startRouteDate:
example: 1585432659695
type: number
startTime:
example: 1585440863815
type: number
format: int64
state:
example: 1
type: number
status:
example: Completed
type: string
terminalId:
example: ""
type: string
timeZone:
example: America/Los_Angeles
type: string
traceSubmitStatus:
example: Completed
type: string
trackingStatus:
example: NotStarted
type: string
transNo:
example: "14309"
type: string
transType:
example: Sale
type: string
transactionRefundStatus:
example: None
type: string
updated:
example: false
type: boolean
type: object
TransactionsResponse:
properties:
limit:
example: 200
type: number
skip:
example: 0
type: number
total:
example: 138
type: number
values:
items:
properties:
active:
example: false
type: boolean
assignedEmployeeId:
example: 5cba1d65e7198807f4ba7163
type: string
cart:
properties:
adjustmentAmount:
example: 0
type: number
afterTaxDiscount:
example: 0
type: number
appliedAfterTaxDiscount:
example: 0
type: number
balanceDue:
example: 0
type: number
calcCartDiscount:
example: 0
type: number
cashReceived:
example: 120
type: number
changeDue:
example: -4.92
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
created:
example: 1556055323017
type: number
format: int64
creditCardFee:
example: 0
type: number
deleted:
example: false
type: boolean
deliveryDiscount:
example: 0
type: number
deliveryDiscountType:
example: Cash
type: string
deliveryFee:
example: 0
type: number
deliveryPromotionId:
example: string
type: string
discount:
example: 0
type: number
discountType:
example: Percentage
type: string
enableCreditCardFee:
example: false
type: boolean
enableDeliveryFee:
example: false
type: boolean
finalRefundAmt:
example: 0
type: number
id:
example: 5cbf851b33b485082543b7a2
type: string
items:
items:
properties:
availableDiscountQty:
example: 0
type: number
batchId:
example: 5c9fe425e0faca07db94b990
type: string
batchSku:
example: 0
type: number
calcCultivationTax:
example: 0
type: number
calcDiscount:
example: 0
format: double
type: number
calcPreTax:
example: 0
type: number
calcTax:
example: 8.3147
format: double
type: number
cogs:
example: 69.1
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
cost:
example: 45
format: double
type: number
created:
example: 1556055338248
format: int64
type: number
deleted:
example: false
type: boolean
discount:
example: 0
format: double
type: number
discountType:
example: Cash
type: string
discountedQty:
example: 0
format: double
type: number
exchangeAmount:
example: 0
type: number
exchangeQty:
example: 0
type: number
exciseTax:
example: 0.7135
format: double
type: number
finalPrice:
example: 45
format: double
type: number
finalized:
example: false
type: boolean
fulfilled:
example: true
type: boolean
id:
example: 5cbf852a1d5dbc081de754fa
type: string
ignoreMixMatch:
example: false
type: boolean
mixMatched:
example: false
type: boolean
modified:
example: 1556066737723
format: int64
type: number
orderItemId:
example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7
type: string
origQuantity:
example: 1
format: double
type: number
overridePrice:
example: 0
type: number
perUnitRefundAmt:
example: 0
type: number
prepackage:
example: 5c9fe425e0faca07db94b990
type: string
prepackageId:
example: 5c9fe425e0faca07db94b990
type: string
prepackageItemId:
example: 5c9fe425e0faca07db94b990
type: string
prepackageProductItem:
example: 5c9fe425e0faca07db94b990
type: string
preparedQty:
example: 0
type: number
product:
example: 0
type: number
productId:
example: 5cbb4dec90427708240820c3
type: string
promotionReqs:
items:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556440873514
type: number
format: int64
deleted:
example: false
type: boolean
id:
example: 5cc567291d31b9081bed54fa
type: string
modified:
example: 1556440873514
type: number
format: int64
promotionId:
example: 5cc521e25fecd30808bc1c97
type: string
rewardId:
example: 5c9fe425e0faca07db94b990
type: string
updated:
example: false
type: boolean
type: object
type: array
quantity:
example: 1
format: double
type: number
quantityLogs:
items:
properties:
batchId:
example: 5cbea8d5f3a077080f237ce3
type: string
id:
example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7_5c9fe425e0faca07db94b990_5cbea8d5f3a077080f237ce3
type: string
inventoryId:
example: 5c9fe425e0faca07db94b990
type: string
prepackageItemId:
example: 5c9fe425e0faca07db94b990
type: string
quantity:
example: 1
type: number
type: object
type: array
status:
example: Active
type: string
taxOrder:
example: PostTaxed
type: string
taxResult:
properties:
created:
example: 1556066737751
type: number
format: int64
cultivationTaxResult:
properties:
flowerTaxOz:
example: 0
type: number
leafTaxOz:
example: 0
type: number
totalCultivationTax:
example: 0
type: number
totalFlowerOz:
example: 0
type: number
totalFlowerTax:
example: 0
type: number
totalLeafOz:
example: 0
type: number
totalLeafTax:
example: 0
type: number
type: object
deleted:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111a8
type: string
modified:
example: 1556066737751
format: int64
type: number
totalALExciseTax:
example: 4.224
type: number
totalALPostExciseTax:
example: 4.224
type: number
totalCityPreTax:
example: 0
type: number
totalCityTax:
example: 4.9224
type: number
totalCountyPreTax:
example: 0
type: number
totalCountyTax:
example: 0.1354
type: number
totalExciseTax:
example: 0
type: number
totalFedPreTax:
example: 0
type: number
totalFedTax:
example: 0
type: number
totalNALPreExciseTax:
example: 0
type: number
totalPostCalcTax:
example: 8.3147
type: number
totalPreCalcTax:
example: 0
type: number
totalStatePreTax:
example: 0
type: number
totalStateTax:
example: 3.2569
type: number
updated:
example: false
type: boolean
type: object
taxTable:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737751
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111aa
type: string
modified:
example: 1556066737751
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 10
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
countyTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737751
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111ab
type: string
modified:
example: 1556066737751
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0.25
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1556066737751
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1556066737751
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111ad
type: string
modified:
example: 1556066737751
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5cbfb1b176dded08124111a9
type: string
modified:
example: 1556066737751
format: int64
type: number
name:
example: Medicinal - Third Party
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
stateTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737751
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111ac
type: string
modified:
example: 1556066737751
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 6
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Custom
type: string
updated:
example: false
type: boolean
type: object
taxType:
example: Inherit
type: string
totalRefundAmount:
example: 0
type: number
totalRefundQty:
example: 1
type: number
txnLineID:
example: 0
type: number
unitPrice:
example: 45
format: double
type: number
unitQty:
example: 0
format: double
type: number
updated:
example: false
type: boolean
useUnitQty:
example: false
type: boolean
weightKey:
example: UNIT
type: string
type: object
type: array
modified:
example: 1556066737710
type: number
format: int64
paymentOption:
example: Cash
type: string
paymentType:
example: Full
type: string
pointSpent:
example: 0
type: number
promoCode:
example: string
type: string
promotionReqLogs:
items:
properties:
amount:
example: 12
type: number
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556233486913
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cc23d0efbbb0e08264c3cc7
type: string
modified:
example: 1556233486913
format: int64
type: number
promotionId:
example: 5cbf6612e0faca07f6364ed1
type: string
promotionType:
example: Cart
type: string
rewardId:
example: string
type: string
updated:
example: false
type: boolean
type: object
type: array
promotionReqs:
items:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556233486896
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cc23d0efbbb0e08264c3cc2
type: string
modified:
example: 1556233486896
format: int64
type: number
promotionId:
example: 5cbf6612e0faca07f6364ed1
type: string
rewardId:
example: string
type: string
updated:
example: false
type: boolean
type: object
type: array
refundAmount:
example: 0
type: number
refundOption:
example: Void
type: string
refundOrderItemRequests:
items:
properties:
orderItemId:
example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7
type: string
quantity:
example: 1
type: number
refundAmt:
example: 45
type: number
type: object
type: array
requestRefundAmt:
example: 0
type: number
roundAmt:
example: 0
type: number
storageLocation:
example: CashDrawer
type: string
subTotal:
example: 90
type: number
subTotalDiscount:
example: 90
type: number
tax:
example: 0.08
type: number
taxResult:
properties:
created:
example: 1556066737751
format: int64
type: number
cultivationTaxResult:
properties:
flowerTaxOz:
example: 0
type: number
leafTaxOz:
example: 0
type: number
totalCultivationTax:
example: 0
type: number
totalFlowerOz:
example: 0
type: number
totalFlowerTax:
example: 0
type: number
totalLeafOz:
example: 0
type: number
totalLeafTax:
example: 0
type: number
type: object
deleted:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111b4
type: string
modified:
example: 1556066737751
type: number
format: int64
totalALExciseTax:
example: 0
type: number
totalALPostExciseTax:
example: 8.45
type: number
totalCityPreTax:
example: 0
type: number
totalCityTax:
example: 9.84
type: number
totalCountyPreTax:
example: 0
type: number
totalCountyTax:
example: 0.27
type: number
totalExciseTax:
example: 0
type: number
totalFedPreTax:
example: 0
type: number
totalFedTax:
example: 0
type: number
totalNALPreExciseTax:
example: 0
type: number
totalPostCalcTax:
example: 25.08
type: number
totalPreCalcTax:
example: 0
type: number
totalStatePreTax:
example: 0
type: number
totalStateTax:
example: 6.51
type: number
updated:
example: false
type: boolean
type: object
taxTable:
properties:
active:
example: false
type: boolean
cityTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737713
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111a2
type: string
modified:
example: 1556066737713
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 10
type: number
territory:
example: City
type: string
updated:
example: false
type: boolean
type: object
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: MedicinalThirdParty
type: string
countyTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737713
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111a3
type: string
modified:
example: 1556066737713
format: int64
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0.25
type: number
territory:
example: County
type: string
updated:
example: false
type: boolean
type: object
created:
example: 1556066737713
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
federalTax:
properties:
active:
example: false
type: boolean
activeExciseTax:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: false
type: boolean
created:
example: 1556066737713
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111a5
type: string
modified:
example: 1556066737713
type: number
format: int64
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 0
type: number
territory:
example: Federal
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5cbfb1b176dded08124111a1
type: string
modified:
example: 1556066737713
type: number
format: int64
name:
example: Medicinal - Third Party
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
stateTax:
properties:
active:
example: true
type: boolean
activeExciseTax:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
compound:
example: true
type: boolean
created:
example: 1556066737713
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
id:
example: 5cbfb1b176dded08124111a4
type: string
modified:
example: 1556066737713
type: number
format: int64
shopId:
example: 5c9fe425e0faca07db94b970
type: string
taxOrder:
example: PostTaxed
type: string
taxRate:
example: 6
type: number
territory:
example: State
type: string
updated:
example: false
type: boolean
type: object
taxOrder:
example: PostTaxed
type: string
taxType:
example: Custom
type: string
updated:
example: false
type: boolean
type: object
total:
example: 115.08
type: number
totalALExciseTax:
example: 0
type: number
totalCalcTax:
example: 25.08
type: number
totalDiscount:
example: 0
type: number
totalExciseTax:
example: 0
type: number
totalPreCalcTax:
example: 0
type: number
updated:
example: false
type: boolean
type: object
checkinTime:
example: 1556055323017
type: number
format: int64
checkoutType:
example: Direct
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
completedTime:
example: 1556066738522
type: number
format: int64
consumerCartId:
example: string
type: string
created:
example: 1556055323017
format: int64
type: number
createdById:
example: 5cb7b8a94cd84907f646e851
type: string
deleteNote:
properties:
created:
example: 1557363743758
format: int64
type: number
deleted:
example: false
type: boolean
enableOnFleet:
example: false
type: boolean
id:
example: 5cd37c1f819d9e27ca3ed854
type: string
message:
example: Duplicate Transaction
type: string
modified:
example: 1557363743758
format: int64
type: number
updated:
example: false
type: boolean
writerId:
example: string
type: string
writerName:
example: string
type: string
type: object
deleted:
example: false
type: boolean
deliveryAddress:
properties:
address:
example: "25016 River Walk Ln. "
type: string
addressLine1:
example: ""
type: string
city:
example: Santa Clarita
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
country:
example: US
type: string
created:
example: 1556066737667
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cbfb1b176dded081241118e
type: string
modified:
example: 1556066737667
format: int64
type: number
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "91383"
type: string
type: object
dirty:
example: false
type: boolean
endRouteDate:
example: 1556056021575
type: number
endRouteLocation:
example:
- 33.81258146840503
- -116.49588659416557
items:
type: number
type: array
endTime:
example: 1556066737667
type: number
format: int64
eta:
example: 0
type: number
fulfillmentStep:
example: Prepare
type: string
id:
example: 5cbf851b33b485082543b7a1
type: string
loc:
example:
- -118.58774266216771
- 34.37550086531264
items:
type: number
type: array
locked:
example: false
type: boolean
member:
properties:
address:
properties:
address:
example: 23708 Via Andorra
type: string
addressLine1:
example: ""
type: string
city:
example: "Santa Clarita "
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
country:
example: US
type: string
created:
example: 1557335083553
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cd30c2be0faca07d28264a2
type: string
modified:
example: 1557335083553
format: int64
type: number
state:
example: CA
type: string
updated:
example: false
type: boolean
zipCode:
example: "91355"
type: string
type: object
agreementExpired:
example: false
type: boolean
anonymous:
example: false
type: boolean
banPatient:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
consumerType:
example: AdultUse
type: string
consumerUserId:
example: 5cd30b53c3226a084423f9ad
type: string
created:
example: 1557334153111
format: int64
type: number
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
dlExpired:
example: false
type: boolean
dob:
example: 391158000000
type: number
email:
example: rachel_witmer@yahoo.com
type: string
emailOptIn:
example: true
type: boolean
emailVerified:
example: false
type: boolean
enableLoyalty:
example: true
type: boolean
enabledCareGiver:
example: false
type: boolean
firstName:
example: Rachel
type: string
id:
example: 5cd30889e0faca07d2824d83
type: string
identifications:
items:
properties:
assets:
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1557334147632
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cd308830c9ccc081b8a271d
type: string
key:
example: 187ea16f-92cb-44e8-92f9-364efd4a6bff.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-500x500.png"
type: string
modified:
example: 1557334147632
format: int64
type: number
name:
example:
Screen Shot 2019-05-08 at 9.46.57 AM.png
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: string
type: string
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1557334153113
format: int64
type: number
deleted:
example: false
type: boolean
expirationDate:
example: 1653462000000
type: number
frontPhoto:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1557334147632
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cd308830c9ccc081b8a271d
type: string
key:
example: 187ea16f-92cb-44e8-92f9-364efd4a6bff.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-500x500.png"
type: string
modified:
example: 1557334147632
format: int64
type: number
name:
example:
Screen Shot 2019-05-08 at 9.46.57 AM.png
type: string
origURL:
example: string
type: string
priority:
example: 0
type: number
publicURL:
example: string
type: string
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
id:
example: 5cd30889e0faca07d2824d81
type: string
licenseNumber:
example: B8669788
type: string
modified:
example: 1557334153113
format: int64
type: number
state:
example: string
type: string
type:
example: string
type: string
updated:
example: false
type: boolean
verified:
example: false
type: boolean
type: object
type: array
importId:
example: string
type: string
lastName:
example: Whitmer
type: string
lastVisitDate:
example: 1557334153112
type: number
lifetimePoints:
example: 0
type: number
loyaltyPoints:
example: 0
type: number
marketingSource:
example: On Deck
type: string
medical:
example: false
type: boolean
memberGroup:
properties:
active:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1551488486906
format: int64
type: number
defaultGroup:
example: true
type: boolean
deleted:
example: false
type: boolean
dirty:
example: false
type: boolean
discount:
example: 0
type: number
discountType:
example: Percentage
type: string
enablePromotion:
example: false
type: boolean
id:
example: 5c7e8c7b722ed607e61edb25
type: string
memberCount:
example: 144
type: number
memberCountEmailOptIn:
example: 114
type: number
memberCountTextOptIn:
example: 109
type: number
modified:
example: 1557333838706
type: number
format: int64
name:
example: Delivery
type: string
promotionId:
example: 5cc6938d18c8a8081ff8dd0e
type: string
shopId:
example: 5c7e8c7b722ed607e61edb1d
type: string
updated:
example: false
type: boolean
type: object
memberGroupId:
example: 5c7e8c7b722ed607e61edb25
type: string
middleName:
example: string
type: string
modified:
example: 1557335083796
format: int64
type: number
primaryPhone:
example: (630) 294-0678
type: string
qbMapping:
example: string
type: string
recommendationExpired:
example: true
type: boolean
recommendationExpiryLeft:
example: 0
type: number
recommendations:
items:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1557334153113
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cd30889e0faca07d2824d82
type: string
modified:
example: 1557334153113
format: int64
type: number
updated:
example: false
type: boolean
verifyMethod:
example: MANUAL
type: string
type: object
type: array
regionId:
example: string
type: string
searchText:
example:
rachel whitmer 23708 vía
andorra rachel_witmer@yahoo.com (630) 294-0678
delivery
type: string
sex:
example: 1
type: number
shopId:
example: 5c9fe425e0faca07db94b970
type: string
startDate:
example: 1557334153112
type: number
status:
example: Active
type: string
textOptIn:
example: true
type: boolean
updated:
example: false
type: boolean
type: object
memberId:
example: 5cbf84e233b485082543b67d
type: string
memberSignature:
properties:
active:
example: true
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556066699832
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cbfb18ba71c2f082fa6661a
type: string
key:
example: 6efbf882-f4d3-4acb-8723-6da45ef87edf.png
type: string
largeURL:
example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-800x800.png"
type: string
mediumURL:
example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-500x500.png"
type: string
modified:
example: 1556066699832
format: int64
type: number
name:
example: file
type: string
priority:
example: 0
type: number
publicURL:
example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf.png"
type: string
secured:
example: false
type: boolean
thumbURL:
example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-200x200.png"
type: string
updated:
example: false
type: boolean
type: object
memo:
example: string
type: string
metrcId:
example: string
format: int64
type: number
metrcSaleTime:
example: "2019-04-24T00:45:38.522Z"
type: string
mileage:
example: 0
type: number
mileageCalculated:
example: true
type: boolean
modified:
example: 1556503061612
type: number
format: int64
note:
properties:
created:
example: 1557363743758
format: int64
type: number
deleted:
example: false
type: boolean
enableOnFleet:
example: false
type: boolean
id:
example: 5cd37c1f819d9e27ca3ed854
type: string
message:
example: Duplicate Transaction
type: string
modified:
example: 1557363743758
format: int64
type: number
updated:
example: false
type: boolean
writerId:
example: string
type: string
writerName:
example: string
type: string
type: object
overrideInventoryId:
example: 5c9fe425e0faca07db94b990
type: string
paid:
example: false
type: boolean
paidTime:
example: 1556066738522
type: number
format: int64
parentitemNumber:
example: 5cd329d5e0faca07d2832c88
type: string
paymentCardPayments:
items:
properties:
amount:
example: 130.92
type: number
balance:
example: 19.08
type: number
created:
example: 0
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 000ae300b23000dd6000fbc5
type: string
modified:
example: 0
type: number
format: int64
paymentCardNumber:
example: "6058690074011822"
type: string
processedTime:
example: 1556311867003
type: number
format: int64
status:
example: Paid
type: string
statusMessage:
example: string
type: string
type:
example: Linx
type: string
updated:
example: false
type: boolean
type: object
type: array
pointsEarned:
example: 90
type: number
priority:
example: 71
type: number
processedTime:
example: 1556066738522
type: number
format: int64
queueType:
example: Delivery
type: string
routing:
example: false
type: boolean
seller:
properties:
address:
properties:
address:
example: ""
type: string
addressLine1:
example: ""
type: string
city:
example: ""
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
country:
example: US
type: string
created:
example: 1555699043038
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cba1563e7198807f4ba3ce2
type: string
modified:
example: 1555699043038
format: int64
type: number
state:
example: ""
type: string
updated:
example: false
type: boolean
zipCode:
example: ""
type: string
type: object
assigned:
example: true
type: boolean
assignedEmployee:
example: string
type: string
assignedTerminalId:
example: 5c82b3944442190831bca731
type: string
canApplyCustomDiscount:
example: false
type: boolean
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
createOnfleetTask:
example: false
type: boolean
createTookanTask:
example: false
type: boolean
created:
example: 1555698469092
format: int64
type: number
deleted:
example: false
type: boolean
deliveryDate:
example: 0
type: number
disabled:
example: false
type: boolean
dlExpirationDate:
example: "2019-06-11"
type: string
driversLicense:
example: Y3467802
type: string
email:
example: ruben.luna7496@gmail.com
type: string
errorRefundTime:
example: 0
type: number
format: int64
errorTime:
example: 0
type: number
format: int64
firstName:
example: Ruben
type: string
fulfillingFulfillment:
example: false
type: boolean
id:
example: 5cba1325e7198807f4ba2a01
type: string
insuranceCompanyName:
example: Progressive
type: string
insuranceExpireDate:
example: 0
type: number
lastName:
example: Luna
type: string
modified:
example: 1556502543146
format: int64
type: number
onFleetTaskId:
example: string
type: string
onFleetTaskStatus:
example: string
type: string
orderTags:
example:
- Delivery
items:
type: string
type: array
packedBy:
example: 5cb7b8a94cd84907f646e851
type: string
packedDate:
example: 1556055414943
type: number
password:
example: 1Rheg0qew4Y/sOmTJIn7O9RwhFjCQV4i
type: string
payingWithPaymentCard:
example: false
type: boolean
phoneNumber:
example: (951) 392-6663
type: string
pickUpDate:
example: 1556055414943
type: number
pin:
example: "8035"
type: string
preparedBy:
example: 5cb7b8a94cd84907f646e851
type: string
preparedDate:
example: 1556055414943
type: number
preparingFulfillment:
example: false
type: boolean
qbDesktopJournalEntryRef:
example: string
type: string
qbDesktopRefundReceipt:
example: string
type: string
qbDesktopSalesRef:
example: string
type: string
qbErrored:
example: false
type: boolean
qbJournalEntryRef:
example: string
type: string
qbRefundErrored:
example: false
type: boolean
qbRefundReceipt:
example: string
type: string
qbSalesReceiptRef:
example: string
type: string
recentLocation:
properties:
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1557337109403
format: int64
type: number
deleted:
example: false
type: boolean
deviceId:
example: A2D5B987-95F4-479F-83F0-A752A5214EC8
type: string
dirty:
example: false
type: boolean
employeeId:
example: 5cba1632c3cb8e0812d4c12f
type: string
id:
example: 5cd3141535f310083897685c
type: string
loc:
example:
- -118.54924441326274
- 34.38270112968458
items:
type: number
type: array
modified:
example: 1557337109403
type: number
format: int64
name:
example: Pineapples iPhone
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
terminalId:
example: 5c9fe47ae8df3f080d33aa09
type: string
timeCardId:
example: 5cd2d7b80c9ccc081b8999ca
type: string
updated:
example: false
type: boolean
type: object
refundPaymentOptions:
example:
- Cash
- Cash
- StoreCredit
items:
type: string
type: array
refundVersion:
example: string
type: string
registrationExpireDate:
example: 0
type: number
roleId:
example: 5c7e8c7b722ed607e61edb13
type: string
shops:
example:
- 5c9fe425e0faca07db94b970
items:
type: string
type: array
shortId:
example: string
type: string
state:
example: 0
type: number
timeCardId:
example: 5cd2d7b80c9ccc081b8999ca
type: string
tookanTaskId:
example: string
type: string
transactionRefundStatus:
example: Partial_Refund
type: string
updated:
example: false
type: boolean
vehicleLicensePlate:
example: string
type: string
vehicleMake:
example: Mercedes
type: string
vehicleModel:
example: string
type: string
vehiclePin:
example: string
type: string
vinNo:
example: string
type: string
type: object
sellerId:
example: 5cba1d65e7198807f4ba7163
type: string
sellerTerminalId:
example: 5c82b3944442190831bca731
type: string
shopId:
example: 5c9fe425e0faca07db94b970
type: string
source:
example: string
type: string
startRouteDate:
example: 1556056023752
type: number
startRouteLocation:
example:
- 33.81258146840503
- -116.49588659416557
items:
type: number
type: array
startTime:
example: 1556066674249
type: number
format: int64
status:
example: Completed
type: string
terminalId:
example: ""
type: string
timeZone:
example: America/Los_Angeles
type: string
traceMessage:
example: string
type: string
traceSubmitStatus:
example: None
type: string
trackingStatus:
example: NotStarted
type: string
transNo:
example: "71"
type: string
transType:
example: Sale
type: string
transferShopId:
example: string
type: string
updated:
example: false
type: boolean
type: object
type: array
type: object
VendorResponse:
properties:
active:
example: true
type: boolean
additionalAddressList:
example:
- string
items:
type: string
type: array
address:
properties:
address:
example: ""
type: string
city:
example: ""
type: string
companyId:
example: string
type: string
country:
example: US
type: string
created:
example: 1554825414778
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cacc0c66218d174d3f17b0c
type: string
modified:
example: 1554825414778
format: int64
type: number
state:
example: ""
type: string
updated:
example: false
type: boolean
zipCode:
example: ""
type: string
type: object
armsLengthType:
example: ARMS_LENGTH
type: string
assets:
example:
- string
items:
properties:
active:
example: true
type: boolean
assetType:
example: Photo
type: string
companyId:
example: 5c7e8c7b722ed607e61edb06
type: string
created:
example: 1556052368662
format: int64
type: number
deleted:
example: false
type: boolean
id:
example: 5cbf79908a29f808183540e7
type: string
key:
example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png
type: string
largeURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png"
type: string
largeX2URL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png"
type: string
mediumURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png"
type: string
modified:
example: 1556052368662
format: int64
type: number
name:
example: Brian Main DL.png
type: string
priority:
example: 0
type: number
secured:
example: true
type: boolean
thumbURL:
example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png"
type: string
type:
example: Photo
type: string
updated:
example: false
type: boolean
type: object
type: array
backOrderEnabled:
example: false
type: boolean
brandList:
example:
- string
items:
type: string
type: array
brands:
example:
- string
items:
type: string
type: array
companyId:
example: 5cabd4ba6218d148395b402c
type: string
companyLicenses:
example:
- string
items:
type: string
type: array
companyType:
example: string
type: string
created:
example: 1554825414778
format: int64
type: number
credits:
example: 0
type: number
dbaName:
example: string
type: string
deleted:
example: false
type: boolean
description:
example: ""
type: string
email:
example: ""
type: string
fax:
example: ""
type: string
firstName:
example: ""
type: string
id:
example: 5cacc0c66218d174d3f17b0d
type: string
importId:
example: string
type: string
lastName:
example: ""
type: string
licenceType:
example: string
type: string
licenseExpirationDate:
example: 0
type: number
licenseNumber:
example: ""
type: string
mobileNumber:
example: string
type: string
modified:
example: 1554825414778
format: int64
type: number
name:
example: Binsky
type: string
notes:
example:
- string
items:
type: string
type: array
phone:
example: ""
type: string
qbDesktopRef:
example: string
type: string
qbVendorRef:
example:
- string
items:
type: string
type: array
relatedEntity:
example: false
type: boolean
updated:
example: false
type: boolean
vendorKey:
example: NWNhYmQ0YmE2MjE4ZDE0ODM5NWI0MDJjX2JpbnNreQ==
type: string
vendorType:
example: VENDOR
type: string
website:
example: ""
type: string
type: object