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

      /v23.1/Suppliers

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

      Get
      /v23.1/Suppliers
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      SupplierNumber
      integer (int64)
      ExternalCode
      string
      FinancialExportCode
      string
      GS1Code
      integer (int64)
      GeneralName
      string
      VatCode
      string
      Iban
      string
      BIC
      string
      GS1EdiPartyNumber
      integer (int64)
      GS1EdiSupplierPartyNumber
      integer (int64)
      ProductId
      integer (int32)
      PurchasePriceGroupAssignedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      InterbranchProductId
      integer (int32)
      IsInterbrancheOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DcSuppliersOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DcStoreId
      integer (int32)
      IsCancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsSmartSearch
      boolean
      IgnoreChangesOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ExportToNearStOnly
      string
      Valid values[ "All", "Yes", "No" ]
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      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)
      supplierNumber
      integer (int64)
      externalCode
      string
      financialExportCode
      string
      gs1Code
      integer (int64)
      generalName
      string
      vatCode
      string
      defaultGrossProfitPercentage
      number (double)
      iban
      string
      bic
      string
      defaultCommunicationType
      string
      Valid values[ "NotSpecified", "RetailLink", "Email" ]
      acceptMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptShipmentMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptInvoiceMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      administrationEmailAddress
      string
      gS1EdiFormat
      string
      Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
      gS1EdiPartyNumber
      integer (int64)
      gS1EdiSupplierPartyNumber
      integer (int64)
      partyNumberValidated
      boolean
      Default"False"
      poRowOrderType
      string
      Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
      poFtpSubfolder
      string
      poEmailAddress
      string
      supplierType
      string
      Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
      fallbackVatId
      integer (int32)
      information
      string
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockCalculate
      boolean
      Default"False"
      autoStockDefaultMinStockDays
      integer (int32)
      autoStockDefaultMaxStockDays
      integer (int32)
      autoStockDefaultSaleDays
      integer (int32)
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      seasonProfileId
      integer (int32)
      printLabel
      boolean
      Default"False"
      labelClassId
      integer (int32)
      maintainStock
      boolean
      Default"False"
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      isBackorders
      boolean
      Default"False"
      isDisablePreferredSupplierChange
      boolean
      Default"False"
      isConsignmentSupplier
      boolean
      Default"False"
      isInterbranche
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      discountCalculationMethod
      string
      Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
      orderDiscountExecuteOrder
      integer (int32)
      ediDiscountExecuteOrder
      integer (int32)
      performanceDiscountExecuteOrder
      integer (int32)
      freeDiscount1ExecuteOrder
      integer (int32)
      freeDiscount2ExecuteOrder
      integer (int32)
      purchaseOrdersMinimumOrderAmount
      integer (int32)
      ignoreChanges
      boolean
      Default"False"
      defaultDeliveryDays
      integer (int32)
      debitAccountsPayableLedgerId
      integer (int32)
      creditAccountsPayableLedgerId
      integer (int32)
      digitalSaleOrderBoundOrdersAutoFinal
      boolean
      Default"False"
      digitalSaleOrderBoundDropshipmentOrdersAutoFinal
      boolean
      Default"False"
      paymentDiscountSource
      string
      Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
      paymentDiscountTotalExInVat
      string
      Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
      paymentDiscountApplyOnPurchaseOrders
      boolean
      Default"False"
      paymentDiscountApplyOnGoodsIn
      boolean
      Default"False"
      dcSupplier
      boolean
      Default"False"
      dcStoreId
      integer (int32)
      exportToNearSt
      boolean
      Default"False"
      isDerived
      boolean
      Default"False"
      seasonProfileDescription
      string
      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)
      supplierNumber
      integer (int64)
      externalCode
      string
      financialExportCode
      string
      gs1Code
      integer (int64)
      generalName
      string
      vatCode
      string
      defaultGrossProfitPercentage
      number (double)
      iban
      string
      bic
      string
      defaultCommunicationType
      string
      Valid values[ "NotSpecified", "RetailLink", "Email" ]
      acceptMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptShipmentMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptInvoiceMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      administrationEmailAddress
      string
      gS1EdiFormat
      string
      Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
      gS1EdiPartyNumber
      integer (int64)
      gS1EdiSupplierPartyNumber
      integer (int64)
      partyNumberValidated
      boolean
      Default"False"
      poRowOrderType
      string
      Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
      poFtpSubfolder
      string
      poEmailAddress
      string
      supplierType
      string
      Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
      fallbackVatId
      integer (int32)
      information
      string
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockCalculate
      boolean
      Default"False"
      autoStockDefaultMinStockDays
      integer (int32)
      autoStockDefaultMaxStockDays
      integer (int32)
      autoStockDefaultSaleDays
      integer (int32)
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      seasonProfileId
      integer (int32)
      printLabel
      boolean
      Default"False"
      labelClassId
      integer (int32)
      maintainStock
      boolean
      Default"False"
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      isBackorders
      boolean
      Default"False"
      isDisablePreferredSupplierChange
      boolean
      Default"False"
      isConsignmentSupplier
      boolean
      Default"False"
      isInterbranche
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      discountCalculationMethod
      string
      Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
      orderDiscountExecuteOrder
      integer (int32)
      ediDiscountExecuteOrder
      integer (int32)
      performanceDiscountExecuteOrder
      integer (int32)
      freeDiscount1ExecuteOrder
      integer (int32)
      freeDiscount2ExecuteOrder
      integer (int32)
      purchaseOrdersMinimumOrderAmount
      integer (int32)
      ignoreChanges
      boolean
      Default"False"
      defaultDeliveryDays
      integer (int32)
      debitAccountsPayableLedgerId
      integer (int32)
      creditAccountsPayableLedgerId
      integer (int32)
      digitalSaleOrderBoundOrdersAutoFinal
      boolean
      Default"False"
      digitalSaleOrderBoundDropshipmentOrdersAutoFinal
      boolean
      Default"False"
      paymentDiscountSource
      string
      Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
      paymentDiscountTotalExInVat
      string
      Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
      paymentDiscountApplyOnPurchaseOrders
      boolean
      Default"False"
      paymentDiscountApplyOnGoodsIn
      boolean
      Default"False"
      dcSupplier
      boolean
      Default"False"
      dcStoreId
      integer (int32)
      exportToNearSt
      boolean
      Default"False"
      isDerived
      boolean
      Default"False"
      seasonProfileDescription
      string
      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)
      supplierNumber
      integer (int64)
      externalCode
      string
      financialExportCode
      string
      gs1Code
      integer (int64)
      generalName
      string
      vatCode
      string
      defaultGrossProfitPercentage
      number (double)
      iban
      string
      bic
      string
      defaultCommunicationType
      string
      Valid values[ "NotSpecified", "RetailLink", "Email" ]
      acceptMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptShipmentMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      acceptInvoiceMsgsFrom
      string
      Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]
      administrationEmailAddress
      string
      gS1EdiFormat
      string
      Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]
      gS1EdiPartyNumber
      integer (int64)
      gS1EdiSupplierPartyNumber
      integer (int64)
      partyNumberValidated
      boolean
      Default"False"
      poRowOrderType
      string
      Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
      poFtpSubfolder
      string
      poEmailAddress
      string
      supplierType
      string
      Valid values[ "NotSpecified", "Own", "FranchiseSupplier", "CancelledFranchiseSupplier" ]
      fallbackVatId
      integer (int32)
      information
      string
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockCalculate
      boolean
      Default"False"
      autoStockDefaultMinStockDays
      integer (int32)
      autoStockDefaultMaxStockDays
      integer (int32)
      autoStockDefaultSaleDays
      integer (int32)
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      seasonProfileId
      integer (int32)
      printLabel
      boolean
      Default"False"
      labelClassId
      integer (int32)
      maintainStock
      boolean
      Default"False"
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      isBackorders
      boolean
      Default"False"
      isDisablePreferredSupplierChange
      boolean
      Default"False"
      isConsignmentSupplier
      boolean
      Default"False"
      isInterbranche
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      discountCalculationMethod
      string
      Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
      orderDiscountExecuteOrder
      integer (int32)
      ediDiscountExecuteOrder
      integer (int32)
      performanceDiscountExecuteOrder
      integer (int32)
      freeDiscount1ExecuteOrder
      integer (int32)
      freeDiscount2ExecuteOrder
      integer (int32)
      purchaseOrdersMinimumOrderAmount
      integer (int32)
      ignoreChanges
      boolean
      Default"False"
      defaultDeliveryDays
      integer (int32)
      debitAccountsPayableLedgerId
      integer (int32)
      creditAccountsPayableLedgerId
      integer (int32)
      digitalSaleOrderBoundOrdersAutoFinal
      boolean
      Default"False"
      digitalSaleOrderBoundDropshipmentOrdersAutoFinal
      boolean
      Default"False"
      paymentDiscountSource
      string
      Valid values[ "NotSpecified", "EdiMessage", "SupplierCondition" ]
      paymentDiscountTotalExInVat
      string
      Valid values[ "NotSpecified", "TotalExclVat", "TotalInclVat" ]
      paymentDiscountApplyOnPurchaseOrders
      boolean
      Default"False"
      paymentDiscountApplyOnGoodsIn
      boolean
      Default"False"
      dcSupplier
      boolean
      Default"False"
      dcStoreId
      integer (int32)
      exportToNearSt
      boolean
      Default"False"
      isDerived
      boolean
      Default"False"
      seasonProfileDescription
      string
      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