Login
      Contents x
      /v23.1/DiscountAgreements
      • 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/DiscountAgreements

      • Updated on 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/DiscountAgreements
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      StoreIdOrUnassigned
      integer (int32)
      CustomerGroupId
      integer (int32)
      Description
      string
      IsCustomerBoundOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsProductBoundOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsLoyaltyCardBoundOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsIgnoreDiscountAgreementOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsWebshopBoundOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CashInvoiceBoundOnly
      string
      Valid values[ "NotSpecified", "CashOnly", "InvoiceOnly" ]
      IsActiveOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsActiveAndFutureOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IncludePromotionalImage
      boolean
      WithPromotionalImageOnly
      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)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      storeId
      integer (int32)
      customerGroupId
      integer (int32)
      rfmSegmentIds
      string
      description
      string
      promotionalImage
      string (byte)
      promotionalImageThumbnail
      string (byte)
      promotionalText
      string
      isCustomerBound
      boolean
      Default"False"
      isProductBound
      boolean
      Default"False"
      isLoyaltyCardBound
      boolean
      Default"False"
      defaultPercentage
      number (double)
      totalDiscountPercentage
      number (double)
      loyaltyCardTypeId
      integer (int32)
      loyaltyProviderType
      string
      Valid values[ "NotSpecified", "eLoyalty", "Spaaza" ]
      isLoyaltyCardRequired
      boolean
      Default"False"
      isIgnoreDiscountAgreement
      boolean
      Default"False"
      isWebshopBound
      boolean
      Default"False"
      cashInvoiceBound
      string
      Valid values[ "NotSpecified", "CashOnly", "InvoiceOnly" ]
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      storeId
      integer (int32)
      customerGroupId
      integer (int32)
      rfmSegmentIds
      string
      description
      string
      promotionalImage
      string (byte)
      promotionalImageThumbnail
      string (byte)
      promotionalText
      string
      isCustomerBound
      boolean
      Default"False"
      isProductBound
      boolean
      Default"False"
      isLoyaltyCardBound
      boolean
      Default"False"
      defaultPercentage
      number (double)
      totalDiscountPercentage
      number (double)
      loyaltyCardTypeId
      integer (int32)
      loyaltyProviderType
      string
      Valid values[ "NotSpecified", "eLoyalty", "Spaaza" ]
      isLoyaltyCardRequired
      boolean
      Default"False"
      isIgnoreDiscountAgreement
      boolean
      Default"False"
      isWebshopBound
      boolean
      Default"False"
      cashInvoiceBound
      string
      Valid values[ "NotSpecified", "CashOnly", "InvoiceOnly" ]
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      storeId
      integer (int32)
      customerGroupId
      integer (int32)
      rfmSegmentIds
      string
      description
      string
      promotionalImage
      string (byte)
      promotionalImageThumbnail
      string (byte)
      promotionalText
      string
      isCustomerBound
      boolean
      Default"False"
      isProductBound
      boolean
      Default"False"
      isLoyaltyCardBound
      boolean
      Default"False"
      defaultPercentage
      number (double)
      totalDiscountPercentage
      number (double)
      loyaltyCardTypeId
      integer (int32)
      loyaltyProviderType
      string
      Valid values[ "NotSpecified", "eLoyalty", "Spaaza" ]
      isLoyaltyCardRequired
      boolean
      Default"False"
      isIgnoreDiscountAgreement
      boolean
      Default"False"
      isWebshopBound
      boolean
      Default"False"
      cashInvoiceBound
      string
      Valid values[ "NotSpecified", "CashOnly", "InvoiceOnly" ]
      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