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

      /v23.1/VirtualPurchases

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

      Get
      /v23.1/VirtualPurchases
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      ProductId
      integer (int32)
      SupplierId
      integer (int32)
      PurchasePriceGroupId
      integer (int32)
      ExternalCode
      string
      OrderCode
      string
      PurchaseUnitBarcode
      integer (int64)
      CollectionIdentifier
      integer (int64)
      OrderMultiplier
      number (double)
      MinimumOrderQuantity
      number (double)
      PurchaseUnitDimensionId
      integer (int32)
      PurchaseUnitPackageId
      integer (int32)
      PurchaseUnitToPurchaseContentUnitFactor
      number (double)
      PurchaseContentUnitDimensionId
      integer (int32)
      PurchaseContentUnitPackageId
      integer (int32)
      PurchaseContentUnitToConsumerUnitFactor
      number (double)
      IsPreferredSupplierRowOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsAvailableForOrderingOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsCancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      Source
      string
      Valid values[ "NotSpecified", "Unknown", "Organization", "Excel" ]
      IsActiveOnly
      string
      Valid values[ "All", "Yes", "No" ]
      SeasonProfileId
      integer (int32)
      DisplayAssortmentForStoreTypeDifferentationId
      integer (int32)
      CollectionBarcode
      integer (int64)
      CollectionParentBarcode
      integer (int64)
      EslProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PurchasePriceGroupAssignedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DeletedProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      UseStrictModeForCandidateKeys
      boolean
      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)
      productId
      integer (int32)
      supplierId
      integer (int32)
      purchaseStatusRowId
      integer (int32)
      purchasePriceGroupId
      integer (int32)
      externalCode
      string
      orderCode
      string
      purchaseUnitBarcode
      integer (int64)
      collectionIdentifier
      integer (int64)
      orderMultiplier
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitDimensionId
      integer (int32)
      purchaseUnitPackageId
      integer (int32)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitDimensionId
      integer (int32)
      purchaseContentUnitPackageId
      integer (int32)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      cbmPerSingleUnit
      number (double)
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      grossPriceReductionPercentage
      number (double)
      ownPurchasePriceNote
      string
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      defaultDeliveryDays
      integer (int32)
      organizationReference
      string
      organizationModifiedDateTime
      string (date-time)
      isNetNet
      boolean
      Default"False"
      isPreferredSupplierRow
      boolean
      Default"False"
      source
      string
      Valid values[ "NotSpecified", "Unknown", "Organization", "Excel" ]
      isActive
      boolean
      Default"False"
      seasonProfileId
      integer (int32)
      collectionBarcode
      integer (int64)
      collectionAmount
      integer (int32)
      collectionParentBarcode
      integer (int64)
      isDerived
      boolean
      Default"False"
      lastExchangeDateTime
      string (date-time)
      statusCode
      string
      statusDescription
      string
      isCancelled
      boolean
      Default"False"
      isAvailableForOrdering
      boolean
      Default"False"
      supplierNumber
      integer (int64)
      supplierGeneralName
      string
      purchasePriceGroupDescription
      string
      purchaseUnitDimensionShortDescription
      string
      purchaseUnitDimensionDescription
      string
      purchaseUnitPackageShortDescription
      string
      purchaseUnitPackageDescription
      string
      purchaseContentUnitDimensionShortDescription
      string
      purchaseContentUnitDimensionDescription
      string
      purchaseContentUnitPackageShortDescription
      string
      purchaseContentUnitPackageDescription
      string
      pceGrossPurchasePrice
      number (double)
      pcePurchasePrice
      number (double)
      pceOwnPurchasePrice
      number (double)
      consumerUnit
      string
      seasonProfileDescription
      string
      collectionProductId
      integer (int32)
      collectionParentProductId
      integer (int32)
      isCollection
      boolean
      Default"False"
      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)
      productId
      integer (int32)
      supplierId
      integer (int32)
      purchaseStatusRowId
      integer (int32)
      purchasePriceGroupId
      integer (int32)
      externalCode
      string
      orderCode
      string
      purchaseUnitBarcode
      integer (int64)
      collectionIdentifier
      integer (int64)
      orderMultiplier
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitDimensionId
      integer (int32)
      purchaseUnitPackageId
      integer (int32)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitDimensionId
      integer (int32)
      purchaseContentUnitPackageId
      integer (int32)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      cbmPerSingleUnit
      number (double)
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      grossPriceReductionPercentage
      number (double)
      ownPurchasePriceNote
      string
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      defaultDeliveryDays
      integer (int32)
      organizationReference
      string
      organizationModifiedDateTime
      string (date-time)
      isNetNet
      boolean
      Default"False"
      isPreferredSupplierRow
      boolean
      Default"False"
      source
      string
      Valid values[ "NotSpecified", "Unknown", "Organization", "Excel" ]
      isActive
      boolean
      Default"False"
      seasonProfileId
      integer (int32)
      collectionBarcode
      integer (int64)
      collectionAmount
      integer (int32)
      collectionParentBarcode
      integer (int64)
      isDerived
      boolean
      Default"False"
      lastExchangeDateTime
      string (date-time)
      statusCode
      string
      statusDescription
      string
      isCancelled
      boolean
      Default"False"
      isAvailableForOrdering
      boolean
      Default"False"
      supplierNumber
      integer (int64)
      supplierGeneralName
      string
      purchasePriceGroupDescription
      string
      purchaseUnitDimensionShortDescription
      string
      purchaseUnitDimensionDescription
      string
      purchaseUnitPackageShortDescription
      string
      purchaseUnitPackageDescription
      string
      purchaseContentUnitDimensionShortDescription
      string
      purchaseContentUnitDimensionDescription
      string
      purchaseContentUnitPackageShortDescription
      string
      purchaseContentUnitPackageDescription
      string
      pceGrossPurchasePrice
      number (double)
      pcePurchasePrice
      number (double)
      pceOwnPurchasePrice
      number (double)
      consumerUnit
      string
      seasonProfileDescription
      string
      collectionProductId
      integer (int32)
      collectionParentProductId
      integer (int32)
      isCollection
      boolean
      Default"False"
      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)
      productId
      integer (int32)
      supplierId
      integer (int32)
      purchaseStatusRowId
      integer (int32)
      purchasePriceGroupId
      integer (int32)
      externalCode
      string
      orderCode
      string
      purchaseUnitBarcode
      integer (int64)
      collectionIdentifier
      integer (int64)
      orderMultiplier
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitDimensionId
      integer (int32)
      purchaseUnitPackageId
      integer (int32)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitDimensionId
      integer (int32)
      purchaseContentUnitPackageId
      integer (int32)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      cbmPerSingleUnit
      number (double)
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      grossPriceReductionPercentage
      number (double)
      ownPurchasePriceNote
      string
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      defaultDeliveryDays
      integer (int32)
      organizationReference
      string
      organizationModifiedDateTime
      string (date-time)
      isNetNet
      boolean
      Default"False"
      isPreferredSupplierRow
      boolean
      Default"False"
      source
      string
      Valid values[ "NotSpecified", "Unknown", "Organization", "Excel" ]
      isActive
      boolean
      Default"False"
      seasonProfileId
      integer (int32)
      collectionBarcode
      integer (int64)
      collectionAmount
      integer (int32)
      collectionParentBarcode
      integer (int64)
      isDerived
      boolean
      Default"False"
      lastExchangeDateTime
      string (date-time)
      statusCode
      string
      statusDescription
      string
      isCancelled
      boolean
      Default"False"
      isAvailableForOrdering
      boolean
      Default"False"
      supplierNumber
      integer (int64)
      supplierGeneralName
      string
      purchasePriceGroupDescription
      string
      purchaseUnitDimensionShortDescription
      string
      purchaseUnitDimensionDescription
      string
      purchaseUnitPackageShortDescription
      string
      purchaseUnitPackageDescription
      string
      purchaseContentUnitDimensionShortDescription
      string
      purchaseContentUnitDimensionDescription
      string
      purchaseContentUnitPackageShortDescription
      string
      purchaseContentUnitPackageDescription
      string
      pceGrossPurchasePrice
      number (double)
      pcePurchasePrice
      number (double)
      pceOwnPurchasePrice
      number (double)
      consumerUnit
      string
      seasonProfileDescription
      string
      collectionProductId
      integer (int32)
      collectionParentProductId
      integer (int32)
      isCollection
      boolean
      Default"False"
      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