# Gets Transactions by Store

Endpoint: GET /transactions/store/{storeId}
Version: v3.0: 3.26.2.2
Security: Auth API User Token

## Path parameters:

  - `storeId` (string, required)
    Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

## Query parameters:

  - `Filter` (array)
    Only one filter parameter field is allowed for this endpoint.
- checkClosed (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in 
Getting Started Section for more information)

 
It is recommended when pulling transactions to always supply a date range that has already 
been settle in the Point of Sale Systems that are connected to the instance of Yellow Dog. 
Since the CheckClosed Field of the system is a datetime based value supplying a filter as like soe 
filter=checkClosed>=2020-05-29

### Transactions closed between two dates

You can use the filter options for checkClosed to return a specific time range of when they 
were indicated to have been closed to the YellowDog Inventory System.

/transactions?filter=checkClosed>=2020-05-29,checkClosed=2020-05-29 00:00:00,checkClosed=2020-05-29T00:00:00-04:00,checkClosed<=2020-06-01T00:00:00-04:00

All of these request uri stubs will return the same list of all transactions that reflect a
check closed value between 2020-05-29T00:00:00-04:00 and 2020-06-01T00:00:00-04:00

  - `PageNumber` (integer)
    Page Number for the result set.

This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.

For more information see the Getting Started Section for Pagination.

  - `PageSize` (integer)
    Page Size
- Default page size: 100 
- Max page size: 500

This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.

For more information see the Getting Started Section for Pagination.

## Response 200 fields (application/json):

  - `thirdPartyId` (string,null)
    This field serves as a globally unique identifier for a transaction and its lines. 
This ensures all lines associated with a transaction can also be associated to the POS sales event

  - `transactionNumber` (string, required)
    Unique ID representing a collection of multiple lines from a single transaction, also commonly referred to as a check number. This number is usually a receipt and can be used to match up POS transactions to on hand affecting events

  - `checkClosed` (string, required)
    The DateTime that the check was closed or made effective at the point of sale, in ISO 8601 format

  - `employeeNumber` (string,null)
    Alpha numeric code for the Employee that closed the transaction (if available)

  - `employeeName` (string,null)
    Name of the Employee that closed the transaction (if available)

  - `tender` (string,null)
    Method of payment, if there are multiple Tenders, provide a comma separated list of all the tenders used in the Transaction (if available)

  - `registerNumber` (string,null)
    Identifier of the register or pos station that the Transaction was closed on (if available)

  - `registerName` (string,null)
    Name of the register or pos station that the Transaction was closed on (if available)

  - `reference` (string,null)
    Field for recording any notes or additional information about the line

  - `store` (object, required)

  - `store.id` (string)

  - `lines` (array, required)
    Array of individual lines representing the items that were included in this transaction

  - `lines.thirdPartyLineId` (string,null)
    Unique identifier for this transaction line. When provided this should be globally unique across all transactions. 

When the unique identifier from a third party only contains incrementing integers, it is 
required that there be additional data points to ensure that the incrementing integers are
unique across all transactions as additional integrations or instances of the same integration are maintained.

In cases like this the recommended format for thirdPartyLineIds is as followed
uniqueSiteNameOrId_uniqueRevenueCenterId_transactionNumber_transactionLineNumber

Alternatively we have seen GUIDs, cuids or other unique identifiers that are not necessarily
 auto incrementing integers used successfully in the past for the thirdPartyLineIds.

  - `lines.itemNumber` (string,null)
    Third Party Item ID or number; any unique number associated with your item

  - `lines.sku` (string,null)
    Yellow Dog SKU

  - `lines.itemDescription` (string,null)
    Item Description

  - `lines.itemRetail` (number,null)
    Unit Retail for the item

  - `lines.baseRetail` (number,null)
    Standard unit retail for the item; usually the same as ItemRetail.

In some cases, an item might be sold at a different ItemRetail than the standard price, but it is not actually discounted; in this case, the BaseRetail would be different than the ItemRetail

  - `lines.itemDiscount` (number,null)
    Unit Discount for the item. Should always be negative

  - `lines.discountDescription` (string,null)
    Discount Description, comma separated list of any discount descriptions or names that were applied to this line

  - `lines.quantity` (number,null)
    Quantity sold, negative designates a return

  - `lines.transactionLineNumber` (string,null)
    Transaction line number is associated to the individual line of the transaction

  - `lines.modifier` (string,null)
    This field should contain the ThirdPartyLineID of the line it is modifying.

  - `lines.item` (object)

  - `lines.lineNumber` (integer,null)
    Transaction line number, can be an index or a number that is associated to the individual line of the transaction

## Response 500 fields (application/json):

  - `message` (string,null)

  - `errors` (array,null)

  - `errors.extensions` (string,null)


## Response 429 fields