Login
      Contents x
      /v23.1/Webshops
      • 05 Jun 2024
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/Webshops

      • Updated on 05 Jun 2024
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/Webshops
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      Code
      string
      Description
      string
      PassiveOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsCancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      parentWebshopId
      integer (int32)
      code
      string
      description
      string
      webshopType
      string
      Valid values[ "NotSpecified", "ShopServer", "WooCommerce", "Magento2", "ShopwareV5", "Bol", "Shopify", "EffectConnect", "ShopwareV6" ]
      apiUrl
      string
      advancedSettings
      string
      productFallback
      string
      Valid values[ "NotSpecified", "ProductNumber", "ExternalCode", "PLU", "SearchText" ]
      passive
      boolean
      Default"False"
      sendProducts
      boolean
      Default"False"
      sendStock
      boolean
      Default"False"
      sendAlternateStock
      boolean
      Default"False"
      sendParcels
      boolean
      Default"False"
      getOrders
      boolean
      Default"False"
      userName
      string
      password
      string
      lastProductsSyncDateTime
      string (date-time)
      resendFromDate
      string (date-time)
      lastOrdersSyncDateTime
      string (date-time)
      reloadFromDate
      string (date-time)
      senderCustomerId
      integer (int32)
      saleOrderClassId
      integer (int32)
      transportCostsProductId
      integer (int32)
      notSendEPlato
      boolean
      Default"False"
      administrativeCustomerId
      integer (int32)
      administrativeCustomerContactId
      integer (int32)
      administrativeEmailAddressId
      integer (int32)
      collectionAddressCustomerId
      integer (int32)
      returnAddressCustomerId
      integer (int32)
      parcelServicePrinterId
      integer (int32)
      orderPickingPrinterId
      integer (int32)
      secondaryOrderPickingPrinterId
      integer (int32)
      orderPickingFromGoodsInPrinterId
      integer (int32)
      orderPickingReportId
      integer (int32)
      orderPickingFromGoodsInReportId
      integer (int32)
      packingInvoiceSaleReportId
      integer (int32)
      packingVatFreeInvoiceSaleReportId
      integer (int32)
      packingInvoiceReportId
      integer (int32)
      packingVatFreeInvoiceReportId
      integer (int32)
      isCancelled
      boolean
      Default"False"
      fallbackDebtorId
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      allowVatFreeWithoutVatNr
      boolean
      Default"False"
      skipEmailMXValidation
      boolean
      Default"False"
      convertPaymentDeficitToDiscount
      boolean
      Default"False"
      saleTypeId
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      parentWebshopId
      integer (int32)
      code
      string
      description
      string
      webshopType
      string
      Valid values[ "NotSpecified", "ShopServer", "WooCommerce", "Magento2", "ShopwareV5", "Bol", "Shopify", "EffectConnect", "ShopwareV6" ]
      apiUrl
      string
      advancedSettings
      string
      productFallback
      string
      Valid values[ "NotSpecified", "ProductNumber", "ExternalCode", "PLU", "SearchText" ]
      passive
      boolean
      Default"False"
      sendProducts
      boolean
      Default"False"
      sendStock
      boolean
      Default"False"
      sendAlternateStock
      boolean
      Default"False"
      sendParcels
      boolean
      Default"False"
      getOrders
      boolean
      Default"False"
      userName
      string
      password
      string
      lastProductsSyncDateTime
      string (date-time)
      resendFromDate
      string (date-time)
      lastOrdersSyncDateTime
      string (date-time)
      reloadFromDate
      string (date-time)
      senderCustomerId
      integer (int32)
      saleOrderClassId
      integer (int32)
      transportCostsProductId
      integer (int32)
      notSendEPlato
      boolean
      Default"False"
      administrativeCustomerId
      integer (int32)
      administrativeCustomerContactId
      integer (int32)
      administrativeEmailAddressId
      integer (int32)
      collectionAddressCustomerId
      integer (int32)
      returnAddressCustomerId
      integer (int32)
      parcelServicePrinterId
      integer (int32)
      orderPickingPrinterId
      integer (int32)
      secondaryOrderPickingPrinterId
      integer (int32)
      orderPickingFromGoodsInPrinterId
      integer (int32)
      orderPickingReportId
      integer (int32)
      orderPickingFromGoodsInReportId
      integer (int32)
      packingInvoiceSaleReportId
      integer (int32)
      packingVatFreeInvoiceSaleReportId
      integer (int32)
      packingInvoiceReportId
      integer (int32)
      packingVatFreeInvoiceReportId
      integer (int32)
      isCancelled
      boolean
      Default"False"
      fallbackDebtorId
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      allowVatFreeWithoutVatNr
      boolean
      Default"False"
      skipEmailMXValidation
      boolean
      Default"False"
      convertPaymentDeficitToDiscount
      boolean
      Default"False"
      saleTypeId
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      parentWebshopId
      integer (int32)
      code
      string
      description
      string
      webshopType
      string
      Valid values[ "NotSpecified", "ShopServer", "WooCommerce", "Magento2", "ShopwareV5", "Bol", "Shopify", "EffectConnect", "ShopwareV6" ]
      apiUrl
      string
      advancedSettings
      string
      productFallback
      string
      Valid values[ "NotSpecified", "ProductNumber", "ExternalCode", "PLU", "SearchText" ]
      passive
      boolean
      Default"False"
      sendProducts
      boolean
      Default"False"
      sendStock
      boolean
      Default"False"
      sendAlternateStock
      boolean
      Default"False"
      sendParcels
      boolean
      Default"False"
      getOrders
      boolean
      Default"False"
      userName
      string
      password
      string
      lastProductsSyncDateTime
      string (date-time)
      resendFromDate
      string (date-time)
      lastOrdersSyncDateTime
      string (date-time)
      reloadFromDate
      string (date-time)
      senderCustomerId
      integer (int32)
      saleOrderClassId
      integer (int32)
      transportCostsProductId
      integer (int32)
      notSendEPlato
      boolean
      Default"False"
      administrativeCustomerId
      integer (int32)
      administrativeCustomerContactId
      integer (int32)
      administrativeEmailAddressId
      integer (int32)
      collectionAddressCustomerId
      integer (int32)
      returnAddressCustomerId
      integer (int32)
      parcelServicePrinterId
      integer (int32)
      orderPickingPrinterId
      integer (int32)
      secondaryOrderPickingPrinterId
      integer (int32)
      orderPickingFromGoodsInPrinterId
      integer (int32)
      orderPickingReportId
      integer (int32)
      orderPickingFromGoodsInReportId
      integer (int32)
      packingInvoiceSaleReportId
      integer (int32)
      packingVatFreeInvoiceSaleReportId
      integer (int32)
      packingInvoiceReportId
      integer (int32)
      packingVatFreeInvoiceReportId
      integer (int32)
      isCancelled
      boolean
      Default"False"
      fallbackDebtorId
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      allowVatFreeWithoutVatNr
      boolean
      Default"False"
      skipEmailMXValidation
      boolean
      Default"False"
      convertPaymentDeficitToDiscount
      boolean
      Default"False"
      saleTypeId
      integer (int32)
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout