WinShopAPI docs
ReferenceDocumentsPOSShopping session

Scan a barcode into a shopping session

Resolves one scanned barcode against the session and reports what it is through `type` — a product, a customer card, or nothing recognised — with the matching payload filled in. Use this as the single entry point for till scanning instead of deciding the barcode's kind up front. Requires `Permissions.PosShoppingSession.View`.

POST
/api/documents/pos/shopping-session/{sessionId}/scan

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

sessionId*integer
Formatint64

Request Body

application/json
  1. body
barcode?string
quantity?number
Formatdecimal

Response Body

application/json
  1. response
customer?
product?array<>|null
type?ShoppingSessionScanResponseType
Value in"NotFound""Product""CustomerCard"
curl -X POST 'https://<your-instance>/api/documents/pos/shopping-session/0/scan' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "customer": {    "account": "string",    "address1": "string",    "address2": "string",    "address3": "string",    "alias": "string",    "allocatedVolumeOfReceivables": 0,    "allowOnlyItemsFromCustomerPriceList": true,    "automaticOrder": true,    "availableVolumeOfReceivables": 0,    "bank": "string",    "bankCode": "stri",    "bankConnectionCode": 0,    "bankConstantSymbol": "string",    "bankSpecificSymbol": "string",    "birthCertificateNumber": "string",    "brokerId": 0,    "businessRegister": "string",    "businessSalesCenter": "string",    "changeOriginId": 0,    "citizenship": "string",    "city": "string",    "claims": 0,    "communicationLanguage": "string",    "companyCreationDate": "2019-08-24T14:15:22Z",    "companyIdentificationNumber": "string",    "companyTypeId": 0,    "connectedUserId": 0,    "contactAddressAddress1": "string",    "contactAddressAddress2": "string",    "contactAddressAddress3": "string",    "contactAddressCity": "string",    "contactAddressCountry": "string",    "contactAddressEmail": "string",    "contactAddressFax": "string",    "contactAddressIcq": "string",    "contactAddressPhone": "string",    "contactAddressWebsiteUrl": "string",    "contactAddressZipCode": "string",    "contactUserId": 0,    "country": "string",    "countryId": 0,    "createdAt": "2019-08-24T14:15:22Z",    "createdAtBranch": "string",    "credit": 0,    "creditBalance": 0,    "creditDrawing": 0,    "creditPaymentDiscountPercent": 0,    "creditWorthinessId": 0,    "currencyId": 0,    "currentTurnover": 0,    "customerAuthorizedPersonId": 0,    "customerId": "string",    "customerPriceListId": 0,    "customerSalesCenter": "string",    "dateOfBirth": "2019-08-24T14:15:22Z",    "dateOfLastAresControl": "2019-08-24T14:15:22Z",    "dateOfLastPurchase": "2019-08-24T14:15:22Z",    "defaultCurrencyId": 0,    "defaultWarehouseId": 0,    "deliveryDays": 0,    "directionOfDeliveryId": 0,    "discount": 0,    "discountDrawing": 0,    "discountGroupDeliveryRouteId": 0,    "discountGroupId": 0,    "discountLimit": 0,    "districtId": 0,    "dueDate": 0,    "dueDateCode": "st",    "ediGln": "string",    "ediGlnBranch": "string",    "ediNorm": "string",    "ediPairing": 0,    "ekokomTypeId": 0,    "emailReminderEmailAddress": "string",    "eshopCustomerId": "string",    "eshopLogin": "string",    "eshopPassword": "string",    "feedLink": "string",    "feedPassword": "string",    "feedPath": "string",    "feedType": 0,    "foreignCurrencyId": 0,    "formForCreditNote": "string",    "formForDeliveryNote": "string",    "formForForeignInvoice": "string",    "formForGoodsIssue": "string",    "formForInvoice": "string",    "frameworkOrder": "string",    "gdprValidConsent": true,    "guid": "string",    "homelandAbroadOwn": 0,    "ibanCode": "string",    "id": 0,    "identifyCustomerWhenUsingCustomerCard": true,    "identityCardIssuanceDate": "2019-08-24T14:15:22Z",    "identityCardIssuancePlace": "string",    "identityCardNumber": "string",    "incompleteData": true,    "incotermsCodeId": 0,    "incotermsText": "string",    "initialTurnover": 0,    "intrastatCountryOfOriginId": 0,    "intrastatMovementCodeId": 0,    "intrastatSenderCountryId": 0,    "intrastatTermsOfDeliveryId": 0,    "intrastatTransactionId": 0,    "intrastatTransportTypeId": 0,    "invoicingAddress1": "string",    "invoicingAddress2": "string",    "invoicingAddress3": "string",    "invoicingCity": "string",    "invoicingCountry": "string",    "invoicingName": "string",    "invoicingZipCode": "string",    "isCustomsWarehouse": true,    "isDeliveryNoteOnPOSDisabled": true,    "isDiscountGroupFixed": true,    "isEmailReminderEnabled": 0,    "isInDecline": true,    "isInInsolvency": true,    "isInactive": true,    "isInvoicingDisabled": true,    "isNaturalPerson": true,    "isPaymentOnCreditDisabled": true,    "isSignotecSignatureDeliveryNoteEnabled": true,    "isSmsReminderEnabled": 0,    "isSummaryBillingEnabled": true,    "isTaxWarehouse": true,    "kindOfOperationId": 0,    "labelId": 0,    "lastLoginDate": "2019-08-24T14:15:22Z",    "lastModify": "2019-08-24T14:15:22Z",    "maximumDelayOfMaturity": 0,    "minimalOrderAmount": 0,    "name": "string",    "nameAbbreviated": "string",    "nameValidOnlyTillLogout": true,    "nameWithoutDiacritics": "string",    "note": "string",    "noteForPrinting1": 0,    "noteForPrinting2": 0,    "noteForPrinting3": 0,    "noteForPrinting4": 0,    "noteForPrinting5": 0,    "number": "string",    "optional1Id": 0,    "optional2Id": 0,    "optional3Id": 0,    "overdueReceivables": 0,    "packagingLabelId": 0,    "payToBankAccountNumber": "string",    "paymentTypeId": 0,    "photo": "string",    "placeOfBirth": "string",    "priceId": 0,    "primaryContactEmail": "string",    "primaryContactFax": "string",    "primaryContactFunctionId": 0,    "primaryContactIcq": "string",    "primaryContactMobilePhone": "string",    "primaryContactName": "string",    "primaryContactPhone": "string",    "primaryContactShouldSendMailTo": true,    "primaryContactSmsEnabled": true,    "primaryContactSurname": "string",    "primaryContactTitle": "string",    "priorityOfCoveringSalesOrder": 0,    "purchaseContractNumber": "string",    "regionId": 0,    "routeId": 0,    "routeOrder": 0,    "sapCustomerNumber": "string",    "sellerId": 0,    "serviceDescription": "string",    "sex": 0,    "shippingTerminalOrder": 0,    "shouldContactCustomerCenter": true,    "showOnPackingTerminal": true,    "showOnShippingTerminal": true,    "smsReminderPhoneNumber": "string",    "specializationId": 0,    "surcharge": 0,    "swiftCode": "string",    "totalPoints": 0,    "transportDriverId": 0,    "transportTypeId": 0,    "typeOfCreditAutomaticRenewal": 0,    "typeOfDiscountAutomaticRenewal": 0,    "userId": 0,    "usesSSCC": true,    "vatCode": "strin",    "vatIdentificationNumber": "string",    "vatPayer": true,    "vatRegistrationNumber": "string",    "websiteUrl": "string",    "zipCode": "string",    "customerCard": {      "barcode": "string",      "companyId": 0,      "discount": 0,      "discountAmount": 0,      "discountGroupId": 0,      "guid": "string",      "id": 0,      "isBillingEnabled": true,      "isInvalid": true,      "lastModify": "2019-08-24T14:15:22Z",      "name": "string",      "note": "string",      "validFrom": "2019-08-24T14:15:22Z",      "validTo": "2019-08-24T14:15:22Z"    }  },  "product": [    {      "id": 0,      "internalNumber": 0,      "productId": 0,      "barcode": "string",      "branchId": 0,      "brokerId": 0,      "cancellationOriginalItemGuid": "string",      "color": "string",      "colorId": 0,      "commissionAmount": 0,      "commissionVatRateId": 0,      "createdAt": "2019-08-24T14:15:22Z",      "customerCardId": 0,      "customerCardId1": 0,      "customerId": 0,      "dateOfCreation": "2019-08-24T14:15:22Z",      "deliveryAddressId": 0,      "dimension": "string",      "dimensionId": 0,      "discount": 0,      "discountReasonId": 0,      "electronicSecurity": true,      "fixedPromotion": true,      "foreignCurrencyExchangeRate": 0,      "foreignCurrencyId": 0,      "foreignPrice": 0,      "hasPriceFromBarcode": true,      "hasPriceFromPackage": true,      "headerInternalId": 0,      "insuranceId": 0,      "insurancePrice": 0,      "isBazaar": true,      "isCancellation": true,      "isDownPayment": true,      "isEuRetail": true,      "isReturnablePackaging": true,      "isTakeAway": true,      "isVoucher": true,      "item": 0,      "length": "string",      "lengthId": 0,      "manualDiscount": 0,      "manualDiscountPercentage": 0,      "manualDiscountReasonId": 0,      "manuallyEnteredPrice": true,      "minimalAge": 0,      "minimalAgeType": "string",      "note1": "string",      "note2": "string",      "note3": "string",      "note4": "string",      "orderCustomerItemId": 0,      "orderCustomerItemVariantId": 0,      "orderInternetItemId": 0,      "orderInternetItemVariantId": 0,      "packagePrice": 0,      "points": 0,      "posId": 0,      "price": 0,      "priceId": 0,      "priceWoVat": 0,      "productCode": "string",      "productName": "string",      "promotionBarcode": "string",      "promotionId": 0,      "quantity": 0,      "recyclingFee": 0,      "recyclingFeeId": 0,      "reservationItemId": 0,      "reservationItemVariantId": 0,      "royalty": 0,      "royaltyId": 0,      "setPrice": 0,      "size": "string",      "sizeId": 0,      "skDocumentId": "string",      "stockPrice": 0,      "totalPrice": 0,      "totalPriceWoVat": 0,      "unit": "string",      "unitId": 0,      "userId": 0,      "variant": "string",      "variantId": 0,      "vatRate": 0,      "warehouseId": 0,      "warehouseSellingPrice": 0,      "weight": 0,      "dependentProducts": [        {          "id": 0,          "internalNumber": 0,          "productId": 0,          "barcode": "string",          "branchId": 0,          "brokerId": 0,          "cancellationOriginalItemGuid": "string",          "color": "string",          "colorId": 0,          "commissionAmount": 0,          "commissionVatRateId": 0,          "createdAt": "2019-08-24T14:15:22Z",          "customerCardId": 0,          "customerCardId1": 0,          "customerId": 0,          "dateOfCreation": "2019-08-24T14:15:22Z",          "deliveryAddressId": 0,          "dimension": "string",          "dimensionId": 0,          "discount": 0,          "discountReasonId": 0,          "electronicSecurity": true,          "fixedPromotion": true,          "foreignCurrencyExchangeRate": 0,          "foreignCurrencyId": 0,          "foreignPrice": 0,          "hasPriceFromBarcode": true,          "hasPriceFromPackage": true,          "headerInternalId": 0,          "insuranceId": 0,          "insurancePrice": 0,          "isBazaar": true,          "isCancellation": true,          "isDownPayment": true,          "isEuRetail": true,          "isReturnablePackaging": true,          "isTakeAway": true,          "isVoucher": true,          "item": 0,          "length": "string",          "lengthId": 0,          "manualDiscount": 0,          "manualDiscountPercentage": 0,          "manualDiscountReasonId": 0,          "manuallyEnteredPrice": true,          "minimalAge": 0,          "minimalAgeType": "string",          "note1": "string",          "note2": "string",          "note3": "string",          "note4": "string",          "orderCustomerItemId": 0,          "orderCustomerItemVariantId": 0,          "orderInternetItemId": 0,          "orderInternetItemVariantId": 0,          "packagePrice": 0,          "points": 0,          "posId": 0,          "price": 0,          "priceId": 0,          "priceWoVat": 0,          "productCode": "string",          "productName": "string",          "promotionBarcode": "string",          "promotionId": 0,          "quantity": 0,          "recyclingFee": 0,          "recyclingFeeId": 0,          "reservationItemId": 0,          "reservationItemVariantId": 0,          "royalty": 0,          "royaltyId": 0,          "setPrice": 0,          "size": "string",          "sizeId": 0,          "skDocumentId": "string",          "stockPrice": 0,          "totalPrice": 0,          "totalPriceWoVat": 0,          "unit": "string",          "unitId": 0,          "userId": 0,          "variant": "string",          "variantId": 0,          "vatRate": 0,          "warehouseId": 0,          "warehouseSellingPrice": 0,          "weight": 0,          "dependentOnItemId": 0,          "type": "ReturnablePackaging"        }      ]    }  ],  "type": "NotFound"}

Roll back a foreign-currency payment DELETE

Reverses the foreign-currency payment identified by `paymentGuid`. Returns the whole updated session. Requires `Permissions.PosShoppingSession.Delete`.

Inventory backups

Next Page