Update Sale

Update the product registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the sale you are updating. Example: 80d15c7713a74feeb4c1c5f533697644
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

required	object (license_base)
actions required	object Specific action id from sales/actions for the update request. Note: different put requests require different structures.
price_change_date required	string time stamp in ISO 8601 UTC format representing the time the price change was made.
required	object Trace currency id retrieved from sales/currency_types. Must match original sale currency.
required	Array of objects Array of one or more lots in which you are attempting to update the price on for a particular sale.

Responses

200

400

Bad Request

put/{state}/v1/sales/{id}

Request samples

Payload

application/json

{"license": {"license_number": "XXXRETAIL01"
},
"actions": {"id": "KMSAN0002"
},
"price_change_date": "2021-05-21T20:29:19Z",
"currency": {"id": "KOMCURT0001"
},
"line_items": [{"lot": {"id": "b29cc14d394941d9a2cd48abf64c9d1c"
},
"amount": "10.00"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "XXXRETAIL01",
"type": {"name": "Dispensaries"
}
},
"id": "532ebe135f7a40db837b4445f55b213c",
"receipt_number": "0000012345",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"terminal": "xxxxxxx-1002",
"created_at": {"date": "2021-12-21T01:00:15Z",
"local_time": "2021-12-21T01:00:15"
},
"out_of_state_sale": true,
"identifications": [{"type": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
},
{"type": {"id": "CAKOMIT0002",
"name": "patient_id"
}
},
{"type": {"id": "CAKOMIT0003",
"name": "caregiver_id"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "John",
"last_name": "Smith"
}
},
"line_items": [{"lot": {"id": "487fa179018e45d08b204ca4de67ca6d"
},
"name": "lot name",
"quantity": "1",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"subtotal": "10.00"
},
{"lot": {"id": "9890c38942b948b291ff9ead560468b3"
},
"name": "Lot name",
"quantity": "3",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"subtotal": "30.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"taxes": [{"type": "Local Sales Tax",
"rate": "10.00",
"subtotal": "4.50"
},
{"type": "City Cannabis Tax",
"rate": "5.00",
"subtotal": "2.25"
},
{"type": "State Cannabis Tax",
"rate": "10.00",
"subtotal": "4.50"
}
],
"totals": {"amount": "51.25",
"quantity": "4"
},
"payments": [{"id": "XXXTERM-0001",
"amount": "51.25",
"type": {"id": "CAKOMPT0002"
}
}
],
"entity_state": [{"state": "active",
"date": "2022-02-10T10:57:03Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-02-10T11:00:04Z",
"reason": "sale updated",
"actioned_by": "system generated"
},
{"state": "change_price",
"date": "2022-02-10T11:00:04Z",
"reason": "price updated on 33wa9b62fe1c47e4970c55ec6c7ff899 from 8 to 10",
"actioned_by": "system generated"
}
]
}
},
"warnings": [ ]
}