ordercloud-javascript-sdk
    Preparing search index...

    Class EntitySynchronization

    Index
    As DeleteAdminUsers DeleteBuyers DeleteBuyerUsers DeleteCatalogs DeleteCategories DeleteInventoryRecords DeleteSuppliers DeleteSupplierUsers DeleteUserGroups GetAdminUsers GetBuyers GetBuyerUserGroups GetBuyerUsers GetCatalogs GetCategories GetInventoryRecords GetSuppliers GetSupplierUsers PatchAdminUsers PatchBuyers PatchBuyerUserGroups PatchBuyerUsers PatchCatalogs PatchCategories PatchInventoryRecords PatchSuppliers PatchSupplierUsers SaveAdminUsers SaveBuyers SaveBuyerUsers SaveCatalogs SaveCategories SaveInventoryRecords SaveSuppliers SaveSupplierUsers SaveUserGroups SyncAdminUser SyncBuyer SyncBuyerUser SyncBuyerUserGroup SyncCatalog SyncCategory SyncInventoryRecord SyncSupplier SyncSupplierUser

    • Returns this

      enables impersonation by calling the subsequent method with the stored impersonation token

      EntitySynchronization.As().List() // lists EntitySynchronization using the impersonated users' token

    • Delete the entity sync delivery configuration for admin users Delete the entity sync delivery configuration for AdminUsers Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for buyers Delete the entity sync delivery configuration for Buyers Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for buyer users Delete the entity sync delivery configuration for BuyerUsers Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for catalogs Delete the entity sync delivery configuration for Catalogs Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for categories Delete the entity sync delivery configuration for Categories Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for inventory records Delete the entity sync delivery configuration for InventoryRecords Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for suppliers Delete the entity sync delivery configuration for Suppliers Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for supplier users Delete the entity sync delivery configuration for SupplierUsers Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Delete the entity sync delivery configuration for buyer user groups Delete the entity sync delivery configuration for BuyerUserGroups Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync an admin user Check out the docs for more info

      Parameters

      • syncAdminUser: SyncAdminUser

        Required fields: UserID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a buyer Check out the docs for more info

      Parameters

      • syncBuyer: SyncBuyer

        Required fields: BuyerID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a buyer user Check out the docs for more info

      Parameters

      • syncBuyerUser: SyncBuyerUser

        Required fields: BuyerID, UserID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a buyer user group Check out the docs for more info

      Parameters

      • syncBuyerUserGroup: SyncBuyerUserGroup

        Required fields: BuyerID, UserGroupID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a catalog Check out the docs for more info

      Parameters

      • syncCatalog: SyncCatalog

        Required fields: CatalogID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a category Check out the docs for more info

      Parameters

      • syncCategory: SyncCategory

        Required fields: CatalogID, CategoryID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync an inventory record Check out the docs for more info

      Parameters

      • syncInventoryRecord: SyncInventoryRecord

        Required fields: ProductID, InventoryRecordID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a supplier Check out the docs for more info

      Parameters

      • syncSupplier: SyncSupplier

        Required fields: SupplierID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Sync a supplier user Check out the docs for more info

      Parameters

      • syncSupplierUser: SyncSupplierUser

        Required fields: SupplierID, UserID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods